-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
461 lines (458 loc) · 13.8 KB
/
openapi.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
openapi: 3.0.0
servers: [{"url":"localhost:3000/"}]
info:
description: Esta es la API de Delilah Resto. A continuación te explicamos las funcionalidades.
version: "1.0.0"
title: Delilah API
contact:
email: [email protected]
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: Administrador
description: Funcionalidades reservadas para el administrador
- name: Usuarios Registrados
description: Funcionalidades para usuarios registrados
- name: Endpoints Libres
description: Endpoints con acceso para todos
paths:
/usuarios:
get:
tags:
- Administrador
summary: Accedé a todos los usuarios registrados
description: Trae una lista con todos los usuarios registrados
parameters:
- in: header
name: Authorization
description: Token obtenido al realizar el login desde la cuenta de administrador.
required: true
schema:
type: string
example: "IUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3VhcmlvX3Rva2VuIjp"
responses:
'200':
description: lista de usuarios registrados
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Usuario'
'400':
description: Primero debes iniciar sesión
'403':
description: Acceso denegado. Sólo administradores
post:
tags:
- Endpoints Libres
summary: Crea un nuevo usuario
description: Si se proporcionan los datos requeridos y el nombre de usuario proporcionado está disponible, se creará un nuevo usuario en el sistema.
responses:
'201':
description: El usuario ha sido creado con éxito
'400':
description: Error
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/UsuarioNoDisp'
- $ref: '#/components/schemas/FaltanDatos'
example: Hay campos obligatorios vacíos
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Post-Usuario'
description: Datos del usuario a crear
/login:
post:
tags:
- Endpoints Libres
summary: Autentica usuarios
description: Dado un nombre de usuario y una contraseña, corrobora los datos con la base de datos. De existir el usuario y estar bien los datos, devuelve el token necesario para futuras autenticaciones.
responses:
'400':
description: Error
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NoUsuario'
- $ref: '#/components/schemas/NoContrasena'
- $ref: '#/components/schemas/NoAutentica'
example: "Usuario Inexistente"
'200':
description: Token para futuras autenticaciones
content:
application/json:
schema:
type: object
properties:
token:
type: string
example: "IUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3VhcmlvX3Rva2VuIjp7Im"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsuarioLogin'
description: Nombre de usuario y contraseña
/productos:
post:
tags:
- Administrador
summary: Crea un nuevo producto
description: Dado un nombre de producto y un precio, lo agrega a la lista de productos disponibles.
parameters:
- in: header
name: Authorization
description: Token obtenido al realizar el login desde la cuenta de administrador.
required: true
schema:
type: string
example: "IUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3VhcmlvX3Rva2VuIjp"
responses:
'400':
description: Primero debes iniciar sesión
'403':
description: Acceso denegado. Sólo administradores
'200':
description: Se ha agregado el nuevo producto a la base de datos
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Producto'
description: Nombre y precio del producto a agregar
get:
tags:
- Usuarios Registrados
- Administrador
summary: Accede a los productos disponibles
description: Trae una lista con todos los productos disponibles
parameters:
- in: header
name: Authorization
description: Token obtenido al realizar el login.
required: true
schema:
type: string
example: 5cCI6IkpXVCJ9.eyJ1c3VhcmlvX3Rva2Vu
responses:
'200':
description: lista de productos
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Producto'
'401':
description: Primero debes iniciar sesión
'403':
description: Token inválido
/productos/{id}:
delete:
tags:
- Administrador
summary: Elimina un producto
description: Dado el id de un producto, lo elimina de la base de datos.
parameters:
- name: id
in: path
description: ID del producto a eliminar
required: true
schema:
type: integer
example: 1
- in: header
name: Authorization
description: Token obtenido al realizar el login desde la cuenta de administrador.
required: true
schema:
type: string
example: "IUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3VhcmlvX3Rva2VuIjp"
responses:
'200':
description: Se ha eliminado el producto
'400':
description: Primero debes iniciar sesión
'403':
description: Acceso denegado. Sólo administradores
patch:
tags:
- Administrador
summary: Edita un producto existente.
description: Dado el id de un producto, un nuevo nombre y/o precio, se actualiza el registro en la base de datos.
parameters:
- name: id
in: path
description: ID del producto a editar
required: true
schema:
type: integer
example: 1
- in: header
name: Authorization
description: Token obtenido al realizar el login desde la cuenta de administrador.
required: true
schema:
type: string
example: "IUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3VhcmlvX3Rva2VuIjp"
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/CambiosOK'
- $ref: '#/components/schemas/NuevoNombre'
- $ref: '#/components/schemas/NuevoPrecio'
example: Se realizaron los cambios
'400':
description: Primero debes iniciar sesión
'403':
description: Acceso denegado. Sólo administradores
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ActualizarProducto'
description: Nuevo nombre y/o nuevo precio del producto
/pedidos:
post:
tags:
- Usuarios Registrados
summary: Crea un nuevo pedido
description: Dados los datos requeridos, realiza un nuevo pedido.
responses:
'401':
description: Primero debes iniciar sesión
'403':
description: Token inválido
'200':
description: El pedido fue realizado con éxito
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PedidoUsuario'
description: Los productos se informan en forma de lista con los ID de los productos pedidos por el usuario, acompañado de un array de las cantidades de los mismos. Las posiciones deben corresponderse. Es necesario además aclarar la dirección de entrega y el método de pago.
get:
tags:
- Administrador
summary: Accede a todos los pedidos
description: Trae una lista con todos los pedidos registrados en la base de datos. Por cada pedido, devuelve tantos registros como productos diferentes posea.
parameters:
- in: header
name: Authorization
description: Token obtenido al realizar el login desde la cuenta del administrador.
required: true
schema:
type: string
example: aaSSDdFr4567
responses:
'200':
description: lista de pedidos
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PedidoAdmin'
'401':
description: Primero debes iniciar sesión
'403':
description: Acceso denegado. Sólo administradores
/pedidos/{id}:
patch:
tags:
- Administrador
summary: Edita el estado de un pedido.
description: Dado el id de un pedido y un nuevo estado, se actualiza el registro en la base de datos.
parameters:
- name: id
in: path
description: ID del pedido a actualizar
required: true
schema:
type: integer
example: 1
- in: header
name: Authorization
description: Token obtenido al realizar el login desde la cuenta del administrador.
required: true
schema:
type: string
example: aaSSDdFr4567
responses:
'200':
description: El estado del pedido fue modificado
'401':
description: Primero debes iniciar sesión
'403':
description: Acceso denegado. Sólo administradores
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ActualizarPedido'
description: Nuevo estado del pedido
components:
schemas:
Post-Usuario:
type: object
properties:
nombreusuario:
type: string
example: pepep1994
password:
type: string
example: "contraseña234"
nombre:
type: string
example: Pepe
apellido:
type: string
example: Perez
email:
type: string
example: [email protected]
telefono:
type: string
example: "911123456"
Usuario:
type: object
properties:
id:
type: integer
example: 1
nombre_usuario:
type: string
example: pepep1994
nombre:
type: string
example: Pepe
apellido:
type: string
example: Perez
mail:
type: string
example: [email protected]
telefono:
type: string
example: "911123456"
admin:
type: integer
example: 0
UsuarioLogin:
type: object
properties:
nombreusuario:
type: string
example: pepep1994
password:
type: string
example: "contraseña234"
Producto:
type: object
properties:
nombre:
type: string
example: Hamburguesa
precio:
type: integer
example: 400
ActualizarProducto:
type: object
properties:
nuevo_nombre:
type: string
example: Hamburguesa Clásica
nuevo_precio:
type: integer
example: 450
PedidoUsuario:
type: object
properties:
productos:
type: array
items:
type: integer
example: [1,3,5]
cantidades:
type: array
items:
type: integer
example: [1,1,2]
dirección:
type: string
example: Avenida Corrientes 235
metodo_pago:
type: string
example: "Efectivo"
PedidoAdmin:
type: object
properties:
id:
type: integer
example: 1
estado:
type: string
default: "Nuevo"
example: "En Preparación"
usuario_id:
type: integer
example: 4
direccion:
type: string
example: Av Corrientes 245
total:
type: integer
example: 2500
metodo_pago:
type: string
example: Débito
hora:
type: string
example: "2020-03-25T00:48:08.000Z"
nombre_producto:
type: string
example: Hamburguesa
cantidad:
type: integer
example: 3
ActualizarPedido:
type: object
properties:
nuevo_estado:
type: string
example: "Cancelado"
FaltanDatos:
type: string
example: "Hay campos obligatorios vacíos"
UsuarioNoDisp:
type: string
example: "El nombre de usuario no está disponible"
NoUsuario:
type: string
example: "Usuario Inexistente"
NoContrasena:
type: string
example: "Contraseña incorrecta"
NoAutentica:
type: string
example: "Ha ocurrido un error autenticando"
CambiosOK:
type: string
example: "Se realizaron los cambios"
NuevoNombre:
type: string
example: "El nombre del producto ha sido actualizado"
NuevoPrecio:
type: string
example: "El precio del producto ha sido actualizado"