Repository navigation
Expand file tree
/
Copy pathopenapi2.json
More file actions
335 lines (333 loc) · 8.44 KB
/
Copy pathopenapi2.json
File metadata and controls
335 lines (333 loc) · 8.44 KB
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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
{
"openapi": "3.0.0",
"info": {
"title": "Complex Example API",
"description": "A more complex example API to demonstrate OpenAPI capabilities.",
"version": "1.1.0"
},
"servers": [
{
"url": "https://api.example.com",
"description": "Production Server"
},
{
"url": "https://staging-api.example.com",
"description": "Staging Server"
}
],
"paths": {
"/api/v2/users": {
"get": {
"summary": "Get list of users",
"description": "Fetch a list of all users in the system.",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number for pagination",
"required": false,
"schema": {
"type": "integer",
"example": 1
}
},
{
"name": "limit",
"in": "query",
"description": "Number of users per page",
"required": false,
"schema": {
"type": "integer",
"example": 10
}
}
],
"responses": {
"200": {
"description": "A list of users.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
}
},
"500": {
"description": "Internal server error"
}
}
},
"post": {
"summary": "Create a new user",
"description": "Creates a new user in the system.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewUser"
}
}
}
},
"responses": {
"201": {
"description": "User created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Invalid input"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/api/v2/users/{userId}": {
"get": {
"summary": "Get user by ID",
"description": "Fetch a single user by their unique ID.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "ID of the user to fetch",
"required": true,
"schema": {
"type": "string",
"example": "123"
}
}
],
"responses": {
"200": {
"description": "User found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"404": {
"description": "User not found"
},
"500": {
"description": "Internal server error"
}
}
},
"put": {
"summary": "Update user by ID",
"description": "Updates the details of an existing user.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "ID of the user to update",
"required": true,
"schema": {
"type": "string",
"example": "123"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUser"
}
}
}
},
"responses": {
"200": {
"description": "User updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"404": {
"description": "User not found"
},
"400": {
"description": "Invalid input"
},
"500": {
"description": "Internal server error"
}
}
},
"delete": {
"summary": "Delete user by ID",
"description": "Deletes a user from the system.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "ID of the user to delete",
"required": true,
"schema": {
"type": "string",
"example": "123"
}
}
],
"responses": {
"200": {
"description": "User deleted successfully"
},
"404": {
"description": "User not found"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/api/v2/auth/login": {
"post": {
"summary": "Login user",
"description": "Authenticates a user and returns a token.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
}
}
},
"responses": {
"200": {
"description": "Authentication successful",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"401": {
"description": "Invalid credentials"
},
"500": {
"description": "Internal server error"
}
}
}
}
},
"components": {
"schemas": {
"User": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123"
},
"username": {
"type": "string",
"example": "johndoe"
},
"email": {
"type": "string",
"example": "johndoe@example.com"
},
"createdAt": {
"type": "string",
"format": "date-time",
"example": "2024-09-16T14:20:00Z"
}
}
},
"NewUser": {
"type": "object",
"properties": {
"username": {
"type": "string",
"example": "johndoe"
},
"email": {
"type": "string",
"example": "johndoe@example.com"
},
"password": {
"type": "string",
"example": "password123"
}
},
"required": ["username", "email", "password"]
},
"UpdateUser": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "newemail@example.com"
},
"password": {
"type": "string",
"example": "newpassword123"
}
}
},
"LoginRequest": {
"type": "object",
"properties": {
"username": {
"type": "string",
"example": "johndoe"
},
"password": {
"type": "string",
"example": "password123"
}
},
"required": ["username", "password"]
},
"LoginResponse": {
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
},
"expiresIn": {
"type": "integer",
"example": 3600
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}