This repository has been archived by the owner on Dec 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathswagger.yaml
531 lines (531 loc) · 12 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
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
basePath: /
definitions:
controller.AddProductPayload:
properties:
client_id:
format: uuid
type: string
comments:
type: string
product_id:
format: uuid
type: string
quantity:
example: 1
minimum: 1
type: integer
required:
- client_id
- product_id
- quantity
type: object
controller.CreateOrderPayload:
properties:
client_id:
format: uuid
type: string
required:
- client_id
type: object
controller.CustomerPayload:
properties:
age:
maximum: 120
minimum: 18
type: integer
cpf:
type: string
email:
type: string
name:
maxLength: 20
minLength: 5
type: string
required:
- cpf
- email
- name
type: object
controller.EditProductPayload:
properties:
client_id:
format: uuid
type: string
comments:
type: string
product_id:
format: uuid
type: string
quantity:
example: 2
type: integer
required:
- client_id
- product_id
- quantity
type: object
controller.GetCartPayload:
properties:
client_id:
format: uuid
type: string
required:
- client_id
type: object
controller.HTTPError:
properties:
error:
type: string
type: object
controller.RemoveProductPayload:
properties:
client_id:
format: uuid
type: string
product_id:
format: uuid
type: string
required:
- client_id
- product_id
type: object
controller.UpdateOrderPayload:
properties:
status:
example: paid
type: string
required:
- status
type: object
customer.Customer:
properties:
age:
type: integer
cpf:
type: string
email:
type: string
id:
type: string
name:
type: string
type: object
order.Order:
properties:
client_id:
type: string
created_at:
type: string
id:
type: string
status:
type: string
total_amount:
type: number
type: object
product.Product:
properties:
category:
type: string
created_at:
type: string
description:
type: string
id:
type: string
name:
type: string
price:
type: number
type: object
host: localhost:8080
info:
contact: {}
description: Fast Food API for FIAP Tech course
title: Tech Challenge Food API
version: 0.1.0
paths:
/cart/add-product:
post:
consumes:
- application/json
description: Adds a Product to Customer's Cart
parameters:
- description: AddProductPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.AddProductPayload'
produces:
- application/json
responses:
"200":
description: OK
"500":
description: '{\"error\": \"Internal Server Error\"}'
schema:
additionalProperties: true
type: object
tags:
- Cart
/cart/edit-product:
post:
consumes:
- application/json
description: Edits a Product from Customer's Cart
parameters:
- description: EditProductPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.EditProductPayload'
produces:
- application/json
responses:
"200":
description: OK
"500":
description: '{\"error\": \"Internal Server Error\"}'
schema:
additionalProperties: true
type: object
tags:
- Cart
/cart/overview:
post:
consumes:
- application/json
parameters:
- description: GetCartPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.GetCartPayload'
produces:
- application/json
responses:
"200":
description: OK
"500":
description: Internal Server Error
tags:
- Cart
/cart/remove-product:
post:
consumes:
- application/json
description: Removes a Product from Customer's Cart
parameters:
- description: RemoveProductPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.RemoveProductPayload'
produces:
- application/json
responses:
"200":
description: OK
"500":
description: Internal Server Error
tags:
- Cart
/customer:
get:
consumes:
- application/json
description: Overview all customer's list
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/customer.Customer'
type: array
summary: Overview customer list
tags:
- Customer
post:
consumes:
- application/json
description: Create a new customer
parameters:
- description: CustomerPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.CustomerPayload'
produces:
- application/json
responses:
"200":
description: customer.Customer
schema:
$ref: '#/definitions/customer.Customer'
"400":
description: '{\"error\": \"Invalid CPF\"}'
schema:
additionalProperties: true
type: object
summary: Create customer
tags:
- Customer
/customer/{cpf}:
get:
consumes:
- application/json
description: Overview a customer by cpf
parameters:
- description: customer cpf
in: path
name: cpf
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/customer.Customer'
"404":
description: Customer not found
summary: Overview customer by cpf
tags:
- Customer
/customer/{id}:
delete:
consumes:
- application/json
description: Delete a customer by id
parameters:
- description: "123456789"
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
"400":
description: Invalid identifier informed
summary: Delete customer
tags:
- Customer
put:
consumes:
- application/json
description: Update a customer by id
parameters:
- description: ID of the customer
in: path
name: id
required: true
type: string
- description: CustomerPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.CustomerPayload'
produces:
- application/json
responses:
"200":
description: customer.Customer
schema:
$ref: '#/definitions/customer.Customer'
"400":
description: '{\"error\": \"Invalid CPF\"}'
schema:
additionalProperties: true
type: object
summary: Update customer
tags:
- Customer
/orders:
get:
consumes:
- application/json
description: Get all order's list
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/order.Order'
type: array
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/controller.HTTPError'
summary: Get order list
tags:
- Order
post:
consumes:
- application/json
description: Create order from Cart
parameters:
- description: CreateOrderPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.CreateOrderPayload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/order.Order'
"400":
description: Bad Request
schema:
$ref: '#/definitions/controller.HTTPError'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/controller.HTTPError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/controller.HTTPError'
summary: Create order from Cart
tags:
- Order
/orders/{id}:
get:
consumes:
- application/json
description: Get an order by ID
parameters:
- description: ID of the order
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/order.Order'
"400":
description: Bad Request
schema:
$ref: '#/definitions/controller.HTTPError'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/controller.HTTPError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/controller.HTTPError'
summary: Get order by ID
tags:
- Order
patch:
consumes:
- application/json
description: Update by json an Order
parameters:
- description: ID of the Order
in: path
name: id
required: true
type: string
- description: UpdateOrderPayload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/controller.UpdateOrderPayload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/order.Order'
"400":
description: Bad Request
schema:
$ref: '#/definitions/controller.HTTPError'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/controller.HTTPError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/controller.HTTPError'
summary: Update an Order
tags:
- Order
/product:
get:
consumes:
- application/json
parameters:
- description: Name of Product
in: path
name: search
type: string
- description: Category of Product
in: path
name: category
type: string
produces:
- application/json
responses:
"200":
description: product.Product
schema:
$ref: '#/definitions/product.Product'
"500":
description: '{\"error\": \"something went bad :(\"}'
schema:
additionalProperties: true
type: object
summary: Search products with given criteria
tags:
- Product
/product/{id}:
delete:
consumes:
- application/json
parameters:
- description: ID of Product
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"204":
description: No Content
"500":
description: '{\"error\": \"something went bad :(\"}'
schema:
additionalProperties: true
type: object
summary: Delete a Product with given ID
tags:
- Product
swagger: "2.0"