-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtoys.yaml
354 lines (348 loc) · 12.3 KB
/
toys.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
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
openapi: 3.0.0
info:
title: OpenAPI спецификация каталога детских игрушек
description: Спецификация для проведения обучения по проектированию и тестирования API
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.1.0
contact:
name: Anton Klimakov
url: https://github.com/MorkovkAs/openapi-example-toys
email: [email protected]
servers:
- url: http://localhost:8080/api/v1
description: Dev server
tags:
- name: Toy
description: "All methods about Toys"
externalDocs:
url: https://github.com/MorkovkAs/openapi-example-toys-autogen
paths:
/toys:
get:
summary: Метод получения игрушек
description: Метод предназначен для получения списка всех игрушек, сохраненных в БД.
operationId: getToys
tags:
- Toy
responses:
'200':
description: Список игрушек
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Toy"
examples:
my_toys:
value:
- toy_id: 12abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Train
status: new
note: Some text
created_at: 2022-07-01T15:00:00+01
- toy_id: 22abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Plane
status: used
note: Some text
created_at: 2022-07-01T15:00:00+01
post:
summary: Метод добавления новой игрушки в каталог
description: Метод предназначен для сохранения в БД данных по новой игрушке.
operationId: createToy
tags:
- Toy
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Toy"
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value:
toy_id: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Submarine
status: new
note: Some text
created_at: 2022-07-01T15:00:00+01
responses:
'200':
description: Подтверждение успешного сохранения
content:
application/json:
schema:
$ref: "#/components/schemas/Toy"
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value:
toy_id: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Submarine
status: new
note: Some text
created_at: 2022-07-01T15:00:00+01
'400':
description: Некорректные входные данные. Возвращает список атрибутов с ошибками
content:
application/json:
schema:
type: array
items:
type: string
/toys/{id}:
get:
summary: Метод получения игрушки по идентификатору
description: Метод предназначен для получения из БД данных по игрушке.
operationId: getToyById
tags:
- Toy
parameters:
- name: id
in: path
required: true
description: Идентификатор игрушки
schema:
type: string
format: uuid
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
responses:
'200':
description: Игрушка
content:
application/json:
schema:
$ref: "#/components/schemas/Toy"
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value:
toy_id: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Submarine
status: new
note: Some text
created_at: 2022-07-01T15:00:00+01
'400':
description: Некорректные входные данные
content:
application/json:
schema:
type: string
put:
summary: Метод обновления игрушки в каталоге
description: Метод предназначен для обновления в БД данных по имеющейся игрушке.
operationId: updateToy
tags:
- Toy
parameters:
- name: id
in: path
required: true
description: Идентификатор игрушки
schema:
type: string
format: uuid
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Toy"
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value:
toy_id: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Submarine
status: used
note: Some updated text
created_at: 2022-07-01T15:00:00+01
responses:
'200':
description: Подтверждение успешного обновления
content:
application/json:
schema:
$ref: "#/components/schemas/Toy"
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value:
toy_id: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Submarine
status: used
note: Some updated text
created_at: 2022-07-01T15:00:00+01
'400':
description: Некорректные входные данные. Возвращает список атрибутов с ошибками
content:
application/json:
schema:
type: array
items:
type: string
'5XX':
description: Любая неожиданная ошибка сервера
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
summary: Метод удаления игрушки по идентификатору
description: Метод предназначен для удаления в БД данных по игрушке.
operationId: deleteToyById
tags:
- Toy
parameters:
- name: id
in: path
required: true
description: Идентификатор игрушки
schema:
type: string
format: uuid
examples:
my_submarine:
summary: Значение для тестового объекта - Submarine
value: 55abcd2b-8b9c-4af9-88f7-0bc180cf74b4
responses:
'204':
description: Успешное удаление
'400':
description: Некорректные входные данные
content:
application/json:
schema:
type: string
/toys/status/{status}:
get:
summary: Метод получения игрушек по состоянию
description: Метод предназначен для получения игрушек из БД по их состоянию.
operationId: getToyByStatus
tags:
- Toy
parameters:
- name: status
in: path
required: true
description: Статус (состояние) игрушки
schema:
type: string
enum:
- new
- used
- broken
examples:
my_toys:
value: new
responses:
'200':
description: Игрушка
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Toy"
examples:
my_toys:
value:
- toy_id: 12abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name: Train
status: new
note: Some text
created_at: 2022-07-01T15:00:00+01
components:
schemas:
Toy:
type: object
required:
- name
- status
properties:
toy_id:
type: string
format: uuid
example: 42abcd2b-8b9c-4af9-88f7-0bc180cf74b4
name:
description: Название игрушки
type: string
example: Train
status:
description: Статус (состояние) игрушки
type: string
enum:
- new
- used
- broken
example: new
note:
description: Описание, пометки
type: string
nullable: true
example: Found on a street
created_at:
description: Дата и время сохранения игрушки в каталоге
type: string
nullable: true
example: 2022-07-01T15:00:00+01
Error:
type: object
required:
- title
- detail
- request
- time
- errorTraceId
properties:
title:
description: Краткое описание проблемы, понятное человеку
type: string
example: Entity not found
detail:
description: Описание конкретно возникшей ошибки, понятное человеку
type: string
example: Entity [Post] with id = [123456] not found. You MUST use POST to add entity instead of PUT
request:
description: Метод и URL запроса
type: string
example: PUT /posts/123456
time:
description: Время возникновения ошибки с точностью до миллисекунд
type: string
example: 1996-12-19T16:39:57.87-08:00
errorTraceId:
description: Идентификатор конкретного возникновения ошибки
type: string
example: ce1ff211-b5dd-4397-b8a8-3f640705efa2
errorCode:
description: Код ошибки по бизнес логике приложения
type: integer
format: int32
example: 57
exception:
description: Тип ошибки
type: string
example: NullPointerException
stacktrace:
description: Stacktrace в случае возникновения на сервере исключения
type: string
example: ...
causeException:
description: Тип первоначального исключения
type: string
example: ...
causeStacketrace:
description: Stacktrace первоначального исключения
type: string
example: ...