-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
207 lines (184 loc) · 4.79 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
openapi: 3.0.0
info:
title: MEN REST API
description: MongoDB ExpressJS NodeJS REST API
version: 1.0.0
servers:
- url: http://localhost:4000/api/
description: Localhost development server
components:
securitySchemes:
ApiKeyAuth: # arbitrary name for the security scheme
type: apiKey
in: header # can be "header", "query" or "cookie"
name: auth-token
schemas:
Product:
type: object
properties:
id:
type: string
name:
type: string
description:
type: string
price:
type: number
inStock:
type: boolean
User:
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
date:
type: string
paths:
/user/register:
post:
summary: Register a new User
description: Register a new User in the database
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/User"
responses:
201:
description: User created succesfully
content:
application/json:
schema:
type: object
properties:
error:
type: string
_id:
type: string
/user/login:
post:
summary: Login a User
description: Login a User in order to get JWT token (auth-token)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
password:
type: string
responses:
200:
description: User logged in succesfully
content:
application/json:
schema:
type: object
properties:
error:
type: string
data:
type: string
/products:
get:
summary: Retrieves a list of Products
description: Retrieves a list of products as JSON objects.
responses:
200:
description: A list of product JSON objects in an array.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Product"
post:
summary: Create a new Product
description: Create a new Product
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
responses:
201:
description: Product created succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
/products/{id}:
get:
summary: Specific Product
description: Retrieves a specific Product based on it id.
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
responses:
200:
description: A Product in the format of a JSON object.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Product"
put:
summary: Updates a specific Product
description: Updates a specific Product based on it id
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
responses:
201:
description: Product updated succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
delete:
summary: Deletes a specific Product
description: Deletes a specific Product based on it id
security:
- ApiKeyAuth: []
parameters:
- in: path
name: id
required: true
description: MongoDB id
schema:
type: string
responses:
201:
description: Product deleted succesfully
content:
application/json:
schema:
$ref: "#/components/schemas/Product"