-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdelilah_resto.yaml
536 lines (531 loc) · 14.9 KB
/
delilah_resto.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
532
533
534
535
536
openapi: 3.0.0
servers:
- description: ServidorLocal
url: http://localhost:3001
info:
title: Delilah Resto
version: 1.0.0
description: API para pedidos de comida deliciosa. Como cliente, podés registrarte, ver el listado de nuestros productos y hacer una orden. Los administradores del restaurante tienen la posibilidad de recibir pedidos y actualizarlos.
tags:
- name: productos
description: Todo sobre nuestros productos
- name: pedidos
description: Acceso a los pedidos de clientes
- name: usuario
description: Operaciones sobre los clientes
paths:
/productos:
get:
tags:
- productos
summary: Ver listado de productos del menú
operationId: verProductos
responses:
'200':
description: Lista de productos traídos exitosamente.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Productos'
'404':
description: Error 404. Lista de productos no encontrada.
post:
tags:
- productos
summary: Agregar un nuevo producto al menú
operationId: agregarProducto
requestBody:
required: true
content:
multipart/mixed:
schema:
$ref: '#/components/schemas/Producto'
encoding:
imagen:
contentType: image/png, image/jpeg
responses:
'200':
description: Producto agregado exitosamente.
content:
application/json:
schema:
$ref: '#/components/schemas/Producto'
'400':
description: El producto ingresado ya existe, intentá con otro.
'400':
description: Error 400. Intente nuevamente.
/productos/{productoId}:
get:
tags:
- productos
summary: Ver un producto por su Id
operationId: verProductoId
parameters:
- in: path
name: productoId
schema:
type: integer
description: ID del producto a buscar
required: true
responses:
'200':
description: Producto traído exitosamente
content:
application/json:
schema:
$ref: '#/components/schemas/Producto'
'404':
description: Error 404. Producto no encontrado
'400':
description: Error 400. Intente nuevamente
put:
tags:
- productos
summary: Editar un producto por su ID
operationId: modificarProducto
parameters:
- in: path
name: productoId
required: true
content:
multipart/mixed:
schema:
$ref: '#/components/schemas/Producto'
encoding:
imagen:
contentType: image/png, image/jpeg
responses:
'200':
description: Producto actualizado exitosamente
content:
application/json:
schema:
$ref: '#/components/schemas/Producto'
'404':
description: Error 404. El producto ingresado no existe. No se actualizó ningun producto
'400':
description: Error 400. Intente nuevamente
delete:
tags:
- productos
summary: Elimina un producto por su ID
operationId: eliminarProducto
parameters:
- in: path
name: productoId
schema:
type: object
properties:
id_producto:
type: integer
required: true
description: Producto a eliminarse
responses:
'200':
description: Producto eliminado exitosamente
'404':
description: Error 404. El producto ingresado no existe. No se actualizó ningun producto
'400':
description: Error 400. Intente nuevamente
/usuarios:
get:
tags:
- usuario
summary: Ver listado de usuarios
operationId: verUsuarios
responses:
'200':
description: Usuarios traídos exitosamente
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Usuarios'
'404':
description: Error 404. Lista de usuarios no encontrada
/usuario/signup:
post:
tags:
- usuario
summary: Registro del usuario en el sistema
operationId: nuevoUsuario
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Usuario'
responses:
'200':
description: Usuario creado exitosamente
content:
application/json:
schema:
$ref: '#/components/schemas/Usuario'
'400':
description: Error 400. Usuario no creado
/usuario/login:
post:
tags:
- usuario
summary: Logueo del usuario al sistema
operationId: "logInUsuario"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UsuarioLogin'
responses:
"200":
description: Usuario logueado exitosamente
"400":
description: Error 400. Intente nuevamente
"400":
descripcion: La contraseña ingresada es incorrecta. Intentá otra vez
"404":
description: Error 404. El usuario ingresado no existe, intentá con otro o registrate para acceder
/pedidos:
get:
tags:
- pedidos
summary: Ver listado de pedidos
operationId: verPedidos
responses:
'200':
description: Pedidos traídos exitosamente
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pedidos'
'404':
description: Error 404. Lista de pedidos no encontrada
'400':
description: Error 400. Intente nuevamente
post:
tags:
- pedidos
summary: Agregar un nuevo pedido
operationId: crearPedido
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PedidoNuevo'
responses:
'200':
description: Pedido creado exitosamente
'400':
description: Error 400. Pedido no creado
/pedidos/{pedidoId}:
get:
tags:
- pedidos
summary: Ver un pedido por su Id
operationId: verPedidoId
parameters:
- in: path
name: pedidoId
schema:
type: integer
description: ID del pedido a buscar
required: true
responses:
'200':
description: Pedido traído exitosamente
content:
application/json:
schema:
$ref: '#/components/schemas/Pedido'
'404':
description: Error 404. Pedido no encontrado
'400':
description: Error 400. Intente nuevamente
put:
tags:
- pedidos
summary: Modificar estado del pedido
operationId: modificarPedido
parameters:
- in: path
name: pedidoId
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PedidoEstado'
responses:
'200':
description: Estado del pedido actualizado exitosamente
'404':
description: Error 404. Pedido no encontrado
'400':
description: Error 400. Intente nuevamente
delete:
tags:
- pedidos
summary: Elimina un pedido por ID
operationId: eliminarPedido
parameters:
- in: path
name: pedidoId
schema:
type: object
properties:
id_pedido:
type: integer
required: true
description: Pedido a eliminarse
responses:
'200':
description: Pedido eliminado exitosamente
'404':
description: Error 404. Pedido no encontrado
'400':
description: Error 400. Intente nuevamente
components:
schemas:
Productos:
type: object
properties:
id_producto:
type: integer
description: ID del producto
example: 4
nombre:
type: string
description: Nombre del producto
example: 'Sandwich de lomito'
precio:
type: number
description: Precio del producto
example: 420
descripcion:
type: string
description: Descripción corta del producto
example: 'Sandwich de lomito a la parrilla con queso'
imagen:
type: string
format: binary
Producto:
type: object
properties:
nombre:
type: string
description: Nombre del producto
example: 'Sandwich de lomito'
precio:
type: number
description: Precio del producto
example: 420
descripcion:
type: string
description: Descripción corta del producto
example: 'Sandwich de lomito a la parrilla con queso'
imagen:
type: string
format: binary
Usuarios:
type: object
properties:
id_usuario:
type: integer
description: ID del usuario
example: 5
usuario:
type: string
description: Usuario
example: 'queen_freddie'
nombre_apellido:
type: string
description: Nombre y apellido del usuario
example: 'Freddie Mercury'
email:
type: string
description: Mail del usuario
example: '[email protected]'
telefono:
type: integer
description: Teléfono del usuario
example: 541144444444
direccion_envio:
type: string
description: Dirección de envío del usuario
example: 'Calle de freddie mercury, londres, uk'
pw:
type: string
description: Contraseña del usuario
example: '1lovemyc4ts'
admin:
type: integer
description: Rol del usuario
example: 2
Usuario:
type: object
properties:
usuario:
type: string
description: Usuario
example: 'queen_freddie'
nombre_apellido:
type: string
description: Nombre y apellido del usuario
example: 'Freddie Mercury'
email:
type: string
description: Mail del usuario
example: '[email protected]'
telefono:
type: integer
description: Teléfono del usuario
example: 54 11 4444 4444
direccion_envio:
type: string
description: Dirección de envío del usuario
example: 'Calle de freddie mercury, londres, uk'
pw:
type: string
description: Contraseña del usuario
example: '1lovemyc4ts'
UsuarioLogin:
type: object
properties:
usuario:
type: string
description: Usuario o email
example: 'queen_freddie'
pw:
type: string
description: Contraseña del usuario
example: '1lovemyc4ts'
Pedidos:
type: object
properties:
id_pedido:
type: integer
description: ID del pedido
example: 5
fecha_pedido:
type: date
description: fecha y hora del pedido
example: 2020-11-15T23:23:08.000Z
estado:
type: string
description: Estado actual del producto
enum:
- nuevo
- confirmado
- preparando
- enviando
- entregado
- cancelado
example: 'nuevo'
tipo_pago:
type: string
description: Tipo de pago elegido para el pedido
enum:
- efectivo
- tarjeta de credito/debito
example: 'efectivo'
nombre:
type: string
description: Nombre del producto elegido
example: 'Sandwich de lomito'
cantidad_producto:
type: integer
description: cantidad pedida del producto
example: 2
precio:
type: number
description: Precio del producto elegido
example: 420
subtotal:
type: number
description: Subtotal del producto * cantidades elegidas
example: 840
usuario:
type: string
description: Usuario que realizo el pedido
example: 'queen_freddie'
nombre_apellido:
type: string
description: Nombre y apellido del usuario que realizo el pedido
example: 'Freddie Mercury'
direccion_envio:
type: string
description: Dirección de envío del usuario que realizo el pedido
example: 'Calle de freddie mercury, londres, uk'
email:
type: string
description: Mail del usuario que realizo el pedido
example: '[email protected]'
Pedido:
type: object
properties:
id_pedido:
type: integer
description: ID del pedido
example: 5
estado:
type: string
description: Estado actual del producto
enum:
- nuevo
- confirmado
- preparando
- enviando
- entregado
- cancelado
example: 'nuevo'
nombre:
type: string
description: Nombre del producto elegido
example: 'Sandwich de lomito'
cantidad_producto:
type: integer
description: cantidad pedida del producto
example: 2
precio:
type: number
description: Precio del producto elegido
example: 420
subtotal:
type: number
description: Subtotal del producto * cantidades elegidas
example: 840
PedidoNuevo:
type: object
properties:
id_pago:
type: integer
description: Tipo de pago elegido
default: 1
productos:
type: array
description: Array de productos encargados
items:
properties:
id_producto:
type: integer
description: Id del pedido
example: 1
cantidad_producto:
type: integer
description: cantidad del producto pedido
example: 2
PedidoEstado:
type: object
properties:
estado_nuevo:
type: integer
description: ID del estado nuevo
example: 2
externalDocs:
description: Explorá la API acá
url: https://github.com/antobayugar/delilah_resto