-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
301 lines (301 loc) · 7.8 KB
/
openapi.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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
openapi: 3.0.3
info:
title: KoaCRUD
description: >
KoaCRUD is an API that manages users, its registrations, listings, updates and deletions.
This app uses the programming language Javascript, its framework Koa.js, the database SQLite3 the APIs documenter Swagger and the test libs Mocha and Chai.
contact:
name: API Support
url: https://github.com/AndreKuratomi
email: [email protected]
version: '2.0'
servers:
- url: http://localhost:3000/swagger
description: Local server
tags:
- name: user
description: Everything related to a single User. Creation, List, Update and Delete.
- name: users
description: All users list.
paths:
/user:
post:
tags:
- user
summary: Registers a user.
description: Registers a user.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserRegisterRequest'
examples:
user:
value:
age: 32
cpf: '00000000000'
email: [email protected]
nome: João da Silva
userWithErrors:
value:
cpf: '00000000000'
email: [email protected]
nome: João da Silva
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
examples:
user:
value:
message: Data added successfully!
'400':
description: Bad request
content:
application/json:
schema:
type: object
examples:
user:
value:
message:
ValidationError:
- Missing field 'age'!
'403':
description: Conflict
content:
application/json:
schema:
type: object
examples:
user:
value:
message: Unauthorized! Users under 18 are not allowed.
/users:
get:
tags:
- users
summary: Lists all users
description: Lists all users.
responses:
'200':
description: Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UsersListResponse'
example:
- id: 1
age: 32
cpf: '00000000000'
email: [email protected]
nome: João da Silva
/user/{user_id}:
get:
tags:
- user
summary: Lists a specific user by its id.
description: Lists a specific user by its id.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/OneUserListResponse'
examples:
user:
value:
id: 1
age: 32
cpf: '00000000000'
email: [email protected]
nome: João da Silva
'400':
description: Bad request
content:
application/json:
schema:
type: object
examples:
UserNotFound:
value:
message: Invalid Id! Must be a number.
'404':
description: Not found
content:
application/json:
schema:
type: object
examples:
UserNotFound:
value:
message: User not found!
'405':
description: Method not allowed
content:
application/json:
schema:
type: object
examples:
MethodNotAllowed:
value:
message: Method Not Allowed
patch:
tags:
- user
summary: Updates a specific user's data by its id.
description: Updates a specific user's data by its id.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
examples:
product:
value:
age: 33
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
example:
message: User successfully updated!
'400':
description: Bad request
content:
application/json:
schema:
type: object
examples:
UserNotFound:
value:
message: Invalid Id! Must be a number.
'404':
description: Not found
content:
application/json:
schema:
type: object
examples:
UserNotFound:
value:
message: User not found!
'405':
description: Method not allowed
content:
application/json:
schema:
type: object
examples:
MethodNotAllowed:
value:
message: Method Not Allowed
delete:
tags:
- user
summary: Deletes a specific user by its id.
description: Deletes a specific user by its id.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No content
'400':
description: Bad request
content:
application/json:
schema:
type: object
examples:
UserNotFound:
value:
message: Invalid Id! Must be a number.
'404':
description: Not found
content:
application/json:
schema:
type: object
examples:
UserNotFound:
value:
message: No user found!
'405':
description: Method not allowed
content:
application/json:
schema:
type: object
examples:
MethodNotAllowed:
value:
message: Method Not Allowed
components:
schemas:
UserRegisterRequest:
type: object
properties:
age:
type: number
cpf:
type: string
email:
type: string
nome:
type: string
UsersListResponse:
type: object
properties:
id:
type: integer
age:
type: number
cpf:
type: string
email:
type: string
nome:
type: string
OneUserListResponse:
type: object
properties:
id:
type: integer
age:
type: number
cpf:
type: string
email:
type: string
nome:
type: string
UpdateUserRequest:
type: object
properties:
age:
type: number