-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
139 lines (139 loc) · 3.65 KB
/
swagger.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
swagger: "2.0"
info:
description: "API (part I) is a free REST API which is written in JavaScript, using Node.js and Express.js, to connect to MongoDB and implement all CRUD (Create, Read, Update and Delete) operations to manage user accounts."
version: "1.0.0"
title: "Swagger API (Part I)"
termsOfService: "https://github.com/andretorresdg"
contact:
email: "[email protected]"
license:
name: "MIT License"
url: "https://github.com/andretorresdg/AndreDevayAPI/blob/master/LICENSE"
tags:
- name: "user"
description: "Operations about user"
schemes:
- "https"
- "http"
paths:
/user:
post:
tags:
- "user"
summary: "Create user"
description: "This command create a new use in MongoDB"
produces:
- "application/json"
parameters:
- in: "body"
name: "user"
description: "User object"
required: true
schema:
$ref: "#/definitions/User"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
400:
description: "invalid form of user"
get:
tags:
- "user"
summary: "Return all the users in the database"
description: "Return all the users in the database"
produces:
- "application/json"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
/user/id:
get:
tags:
- "user"
summary: "Get user by ID"
description: "Return all the info of an user (found by your ID)"
produces:
- "application/json"
parameters:
- name: "id"
in: "path"
description: " A alphanumeric combination that leades to an especif user "
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
400:
description: "Invalid ID supplied"
404:
description: "ID not found"
put:
tags:
- "user"
summary: "Updated an especif user"
description: "Update the info of an especif user (found via ID)"
produces:
- "application/json"
parameters:
- name: "id"
in: "path"
description: "A alphanumeric combination that leades to an especif user"
required: true
type: "string"
- in: "body"
name: "Login info"
description: "All the info that will be updated"
required: true
schema:
$ref: "#/definitions/User"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
400:
description: "Invalid ID supplied"
404:
description: "ID not found"
delete:
tags:
- "user"
summary: "Delete an especif user"
description: "Delete an especif user (found via ID)"
parameters:
- name: "id"
in: "path"
description: "A alphanumeric combination that leades to an especif user"
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
400:
description: "Invalid ID supplied"
404:
description: "ID not found"
definitions:
User:
type: "object"
properties:
id:
type: "string"
email:
type: "string"
first_name:
type: "string"
last_name:
type: "string"
personal_phone:
type: "string"
password:
type: "string"