-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
278 lines (278 loc) · 6.77 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
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
openapi: "3.0.2"
info:
title: "Car management API"
version: "1.0"
servers:
- url: http://localhost:8000/api
paths:
/register/member:
post:
requestBody:
description: Register a new member
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
password:
type: string
example: this is password
responses:
"201":
description: Success
"422":
description: Unprocessable Entity
/register/admin:
post:
security: [{ bearerAuth: [] }]
requestBody:
description: Register a new admin, only superadmin can do this
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
password:
type: string
example: this is strong password
responses:
"201":
description: Success
"401":
description: Unauthorized
"422":
description: Unprocessable Entity
/login:
post:
requestBody:
description: Login with email and password
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
password:
type: string
example: this is strong password
responses:
"201":
description: Success
"401":
description: Invalid email or password
"404":
description: User not found
/users/{id}:
put:
parameters:
- in: path
name: id
schema:
type: integer
format: int64
required: true
description: primary key of the user
requestBody:
description: Update user's information
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
password:
type: string
example: this is strong password
responses:
"201":
description: Success
"422":
description: Unprocessable Entity
delete:
parameters:
- in: path
name: id
schema:
type: integer
format: int64
required: true
description: primary key of the user
requestBody:
description: Delete user
content:
application/json:
schema:
type: object
properties:
email:
type: string
example:
password:
type: string
example:
responses:
"200":
description: Success
"422":
description: Unprocessable Entity
/user:
get:
security:
- bearerAuth: []
responses:
"200":
description: Success
"401":
description: Unauthorized
/cars/available:
get:
responses:
"200":
description: Success
"422":
description: Unprocessable Entity
/cars:
get:
security:
- bearerAuth: []
responses:
"200":
description: Success
"401":
description: Unauthorized
"422":
description: Unprocessable Entity
post:
security:
- bearerAuth: []
requestBody:
description: Add a new car
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Porsche 911
price:
type: integer
example: 1000000
size:
type: string
enum:
- small
- medium
- large
example: medium
available:
type: boolean
example: true
responses:
"201":
description: Success
"401":
description: Unauthorized
"422":
description: Unprocessable Entity
/cars/{id}:
put:
security:
- bearerAuth: []
parameters:
- in: path
name: id
schema:
type: integer
format: int64
required: true
description: primary key of the car
requestBody:
description: Update car's information
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Porsche 911
price:
type: integer
example: 1000000
size:
type: string
enum:
- small
- medium
- large
example: medium
available:
type: boolean
example: true
responses:
"200":
description: Success
"401":
description: Unauthorized
"422":
description: Unprocessable Entity
delete:
security:
- bearerAuth: []
parameters:
- in: path
name: id
schema:
type: integer
format: int64
required: true
description: primary key of the car
responses:
"200":
description: Success
"401":
description: Unauthorized
"422":
description: Unprocessable Entity
/api-docs:
get:
description: Get swagger ui documents
responses:
"200":
description: Success
"500":
description: Internal Server Error
/api-json:
get:
description: Get swagger json documents
responses:
"200":
description: Success
"500":
description: Internal Server Error
/api-yaml:
get:
description: Get swagger yaml documents
responses:
"200":
description: Success
"500":
description: Internal Server Error
components:
securitySchemes:
bearerAuth:
type: apiKey
in: header
name: Authorization
description: Bearer token