-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
353 lines (313 loc) · 8.65 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
swagger: "2.0"
info:
description: "Primera API Proyecto Delilah Restó "
version: 1.0.0
title: Delilah Restó
contact:
email: [email protected]
paths:
/registro:
post:
tags:
- "usuario"
summary: "Agrega un nuevo usuario"
parameters:
- in: "body"
name: "body"
description: "Objeto de usuario que se agrega a la aplicacion"
required: true
schema:
$ref: "#/definitions/usuario"
responses:
"201":
description: "Operación exitosa"
/login:
post:
tags:
- "usuario"
summary: "Iniciar sesión en el sistema"
description: ""
operationId: "loginUser"
produces:
- "application/json"
parameters:
- name: "usuario"
in: "query"
description: "Usuario para ingresar"
required: true
type: "string"
- name: "contrasena"
in: "query"
description: "Contraseña para ingresar"
required: true
type: "string"
responses:
"200":
description: "Usuario logueado"
"401":
description: "Usuario o contraseña errados"
/usuarios:
get:
tags:
- "usuario"
summary: "Obtener la lista de los productos"
description: "Si el usuario tiene rol administrador podrá visualizar todos lo usuarios, si no, sólo visualizará su información"
operationId: "getUsuarios"
responses:
"200":
description: "Operación exitosa"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
/productos:
post:
tags:
- "producto"
summary: "Agregar un nuevo producto"
description: "Esto solo lo puede hacer un usuario logueado y con rol administrador"
parameters:
- in: "header"
name: "token"
required: true
type: "string"
- in: "body"
name: "body"
description: "Objeto de producto que se agrega a la aplicacion"
required: true
schema:
$ref: "#/definitions/producto"
responses:
"201":
description: "Producto registrado con éxito"
get:
tags:
- "producto"
summary: "Obtener la lista de los productos"
description: "Esto sólo lo puede visualizar los usuarios logueados"
operationId: "getProductos"
responses:
"200":
description: "Operación exitosa"
"204":
description: "No hay productos disponibles"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
/productos/{id}:
put:
tags:
- "producto"
summary: "Actualizar producto"
description: "Esto solo lo puede hacer un usuario logueado y con rol administrador"
operationId: "updateUser"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "header"
name: "token"
required: true
type: "string"
- name: "id"
in: "path"
description: "name that need to be updated"
required: true
type: "string"
- in: "body"
name: "body"
description: "Updated user object"
required: true
schema:
$ref: "#/definitions/producto"
responses:
"200":
description: "Se ha actualizado con éxito el producto"
"204":
description: "Producto no encontrado"
delete:
tags:
- "producto"
summary: "Eliminar un producto"
description: "Esto solo lo puede hacer un usuario logueado y con rol administrador"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
- name: "id"
in: "path"
description: "Id del producto a eliminar"
required: true
type: "integer"
format: "int64"
responses:
"200":
description: "El producto se ha eliminado con éxito"
"204":
description: "Producto no encontrado"
/pedidos:
post:
tags:
- "pedido"
summary: "Agregar un nuevo pedido"
description: "Usuarios logueados pueden agregar pedidos, no se solicita ningún campo ya que se asocia automaticamente al usuario logueado y con el estado pendiente"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
responses:
"201":
description: "Nuevo pedido agregado"
get:
tags:
- "pedido"
summary: "Obtener la lista de los pedidos"
description: "Esto sólo lo puede visualizar los usuarios logueados, si el rol es administrador puede ver los pedidos, si es cliente solo los propios."
parameters:
- name: "token"
in: "header"
required: true
type: "string"
responses:
200:
description: OK
/pedidos/{id}/{estado}:
patch:
tags:
- "pedido"
summary: "Actualizar el estado de un pedido"
description: "Solo los usuarios con rol administrador pueden cambia el estado del pedido: pedidos/1?estado=1"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
- name: "id"
in: "path"
description: "Número del pedido"
required: true
type: "integer"
- in: "path"
name: "estado"
description: "Estado del pedido, es un parametro de ruta"
required: true
type: "integer"
responses:
"200":
description: "Pedido actualizado"
/pedidos/{id}/productos:
post:
tags:
- "pedido"
summary: "Agregar un producto al pedido"
description: "Usuarios logueados pueden agregar productos a un pedido que tengan asociado"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
- name: "id"
in: "path"
description: "Número del pedido"
required: true
type: "string"
- in: "body"
name: "body"
description: "Objeto de pedido"
required: true
schema:
$ref: "#/definitions/pedido_productos"
responses:
"201":
description: "Producto agregado al pedido"
/pedidos/{id}:
delete:
tags:
- "pedido"
summary: "Eliminar un pedido"
description: "Esto solo lo puede hacer un usuario logueado y con rol administrador"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
- name: "id"
in: "path"
description: "Id del pedido a eliminar"
required: true
type: "integer"
format: "int64"
responses:
"200":
description: "El pedido se ha eliminado con éxito"
get:
tags:
- "pedido"
summary: "Consultar productos de un pedido"
description: "Si el rol es admin puede ver los productos de cualquier pedido, si es cliente solo los productos de sus pedidos"
parameters:
- name: "token"
in: "header"
required: true
type: "string"
- name: "id"
in: "path"
description: "Id del pedido a consultar"
required: true
type: "integer"
format: "int64"
responses:
"200":
description: "El pedido se ha eliminado con éxito"
definitions:
usuario:
type: "object"
properties:
id:
type: "integer"
nombre_apellido:
type: "string"
correo:
type: "string"
telefono:
type: "string"
direccion:
type: "string"
contrasena:
type: "string"
rol_id:
type: "integer"
producto:
type: "object"
properties:
id:
type: "integer"
nombre:
type: "string"
cantidad:
type: "integer"
precio:
type: "integer"
pedido_productos:
type: "object"
properties:
id:
type: "integer"
id_producto:
type: "integer"
cantidad:
type: "integer"