backend/index.html at dev · SupportMee/backend · GitHub

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
<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<link
			rel="icon"
			type="image/png"
			href="https://img.icons8.com/nolan/64/domain.png"
		/>

		<title>Documentación API - SUPPORT ME!</title>
		<meta name="author" content="SUPPORT ME! TEAM - MOLINA - LóPEZ - LINDAO" />
		<meta name="keywords" content="Django, API, Documentación" />
		<meta
			name="viewport"
			content="width=device-width, initial-scale=1, shrink-to-fit=no"
		/>
		<link
			rel="stylesheet"
			href="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css"
		/>
		<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
		<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
	</head>
	<body>
		<div class="container-fluid">
			<h1>SUPPORT ME! - Documentación</h1>
			<p>
				<strong>Base URL: </strong><span>/</span>, <strong>Version: </strong
				><span>0.1</span>
			</p>
			<p>
				<span><strong>Default request content-types:</strong></span>
				application/json<br />
				<span><strong>Default response content-types:</strong></span>
				application/json<br />
				<span><strong>Schemes:</strong></span>
				HTTP<br />
			</p>
			<h2>Resumen del API</h2>
			<table class="table table-bordered table-striped">
				<thead>
					<tr>
						<th scope="col">Ruta</th>
						<th scope="col">Operacion</th>
						<th scope="col">Authorization</th>
						<th scope="col">Descripcion</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td>/categories</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna todas las categorias de las huecas registradas en la base
							de datos
						</td>
					</tr>
					<tr>
						<td>/category/&ltint:pk&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna la categoria identificado por el id especificado en pk, en
							la url, realizando un filtro en los registros de la base de datos
						</td>
					</tr>
					<tr>
						<td>/cities</td>
						<td>GET</td>
						<td></td>
						<td>Retorna todas las ciudades registrados en la base de datos</td>
					</tr>
					<tr>
						<td>/city/&ltint:pk&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna la ciudad identificado por el id especificado en pk, en la
							url, realizando un filtro en los registros de la base de datos
						</td>
					</tr>
					<tr>
						<td>/comment</td>
						<td>GET</td>
						<td>Token</td>
						<td>
							Guarda en la base de datos, un comentario realizado por un usuario
							en una hueca
						</td>
					</tr>
					<tr>
						<td>/comments/&ltint:hueca&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna todos los comentarios realizados en la hueca recibido como
							parametro en la url
						</td>
					</tr>
					<tr>
						<td>/comment/&ltint:pk&gt</td>
						<td>GET</td>
						<td>Token</td>
						<td>Elimina un comentario de un usuario en una hueca</td>
					</tr>
					<tr>
						<td>/hueca</td>
						<td>POST</td>
						<td>Token</td>
						<td>
							Guarda la informacion de la hueca obtenido en el paquete recibido
							en la base de datos
						</td>
					</tr>
					<tr>
						<td style="vertical-align: middle" rowspan="3">
							/hueca/&ltint:pk&gt
						</td>
						<td>GET</td>
						<td></td>
						<td>
							Responde con un paquete conteniendo la informacion de la hueca
							encontrada por el parametro pk en el servidor
						</td>
					</tr>
					<tr>
						<td>PUT</td>
						<td>Token</td>
						<td>
							Guarda la informacion de la hueca en la base, identificado por pk
						</td>
					</tr>
					<tr>
						<td>DELETE</td>
						<td>Token</td>
						<td>Elimina la hueca identificada por el pk de la base de datos</td>
					</tr>
					<tr>
						<td>/huecas</td>
						<td>GET</td>
						<td></td>
						<td>
							Responde con un paquete que almacena la informacion de todas las
							huecas registradas en el servidor
						</td>
					</tr>
					<tr>
						<td>/huecas/categories/&ltint:category&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna todas las huecas que cumplan con la categoria recibida
							como parametro en category
						</td>
					</tr>
					<tr>
						<td>/huecas/cities/&ltint:city&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Responde con un paquete que contiene todas las huecas asociadas al
							identificador de la ciudad recibido en el requerimiento
						</td>
					</tr>
					<tr>
						<td>/huecas/search/&ltstr:search&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna un listado de huecas cuyo nombre coincidan con el
							parametro search, enviado como parametro
						</td>
					</tr>
					<tr>
						<td>/location/&ltstr:latitude&gt/&ltstr:longitude&gt/&ltstr:km&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Responde con un paquete que contiene las huecas que se encuentren
							cerca de la ubicacion(latitud, longitud) y km.
						</td>
					</tr>
					<tr>
						<td>/image</td>
						<td>POST</td>
						<td>Token</td>
						<td>Almacena la imagen enviada en el paquete en el servidor</td>
					</tr>
					<tr>
						<td>/images/&ltint:hueca&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna todas las imagenes de la base de datos que esten
							relacionadas con el identificador hueca
						</td>
					</tr>
					<tr>
						<td style="vertical-align: middle" rowspan="2">
							/image/&ltint:pk&gt
						</td>
						<td>GET</td>
						<td></td>
						<td>Retorna la imagen identificada por pk de la base de datos</td>
					</tr>
					<tr>
						<td>DELETE</td>
						<td>Token</td>
						<td>
							Elimina la imagen identificada por pk de la base de datos, retorna
							una respuesta de eliminacion exitosa
						</td>
					</tr>
					<tr>
						<td>/menu</td>
						<td>POST</td>
						<td>Token</td>
						<td>
							Recibe la informacion de un plato de comida enviado en el paquete
							y lo guarda en el servidor
						</td>
					</tr>
					<tr>
						<td>/menus/&ltint:hueca&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna todos los platos de comida guardados en el servidor y que
							estan asociados con el parametro hueca
						</td>
					</tr>
					<tr>
						<td style="vertical-align: middle" rowspan="2">
							/menu/&ltint:pk&gt
						</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna un plato de comida de la hueca, el plato es identificado
							en la base por el parametro pk
						</td>
					</tr>
					<tr>
						<td>DELETE</td>
						<td>Token</td>
						<td>
							Elimino un plato de comida de la hueca, el plato a eliminar es
							identificado en la base por el parametro pk
						</td>
					</tr>
					<tr>
						<td>/like</td>
						<td>POST</td>
						<td>Token</td>
						<td>Guarda el registro de un like de un usuario en la hueca</td>
					</tr>
					<tr>
						<td>/likes/&ltint:hueca&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Retorna una listado de los usuarios que han dado like a la hueca
							recibido como parametro
						</td>
					</tr>
					<tr>
						<td style="vertical-align: middle" rowspan="2">
							/like/&ltint:hueca&gt/&ltint:user&gt
						</td>
						<td>GET</td>
						<td>Token</td>
						<td>
							Retorna un like realizado por el user en la hueca, ambos datos son
							recibidos de la url
						</td>
					</tr>
					<tr>
						<td>DELETE</td>
						<td>Token</td>
						<td>
							Elimino un like realizado por el user en la hueca, ambos datos son
							recibidos de la url
						</td>
					</tr>
					<tr>
						<td>/likes/&ltint: user&gt</td>
						<td>GET</td>
						<td>Token</td>
						<td>
							Retorna un listado de las huecas que el usuario le ha dado like
						</td>
					</tr>
					<tr>
						<td>/rating</td>
						<td>POST</td>
						<td>Token</td>
						<td>
							Guardo una calificacion hecha por un usuario en una hueca en el
							servidor
						</td>
					</tr>
					<tr>
						<td>/ratings/&ltint:hueca&gt</td>
						<td>GET</td>
						<td></td>
						<td>
							Regresa las calificaciones hechas por los usuarios en la hueca
							recibido como dato en la url
						</td>
					</tr>
					<tr>
						<td>/rating/&ltint:hueca&gt/&ltint:user&gt</td>
						<td>GET</td>
						<td>Token</td>
						<td>
							Regresa el listado de todas las calificaciones realizadas por el
							usuario definido en user, en la hueca recibida como dato en la url
						</td>
					</tr>
					<tr>
						<td>/user/&ltint:pk&gt</td>
						<td>GET</td>
						<td>Token</td>
						<td>Retorna un usuario</td>
					</tr>
					<tr>
						<td>/login</td>
						<td>POST</td>
						<td></td>
						<td>
							Valida las credenciales de inicio de sesion enviadas por el
							usuario, y retorna una respuesta con el token y datos del usuario
							en caso de validacion exitosa
						</td>
					</tr>
					<tr>
						<td>/signup</td>
						<td>POST</td>
						<td></td>
						<td>
							Registra un nuevo usuario en la aplicacion, donde se valida si las
							credenciales enviadas son las correctas para realizar el registro
						</td>
					</tr>
					<tr>
						<td>/logout/&ltint:pk&gt</td>
						<td>DELETE</td>
						<td>Token</td>
						<td>Elimina el Token del usuario que ha iniciado sesión.</td>
					</tr>
					<tr>
						<td>/update/&ltint:pk&gt</td>
						<td>PUT</td>
						<td>Token</td>
						<td>Actualiza el Usuario.</td>
					</tr>
					<tr>
						<td>/delete/&ltint:pk&gt</td>
						<td>DELETE</td>
						<td>Token</td>
						<td>Elimina el Usuario o simplemente lo desactiva.</td>
					</tr>
					<tr>
						<td>/users</td>
						<td>GET</td>
						<td>Token</td>
						<td>Retorna todos los usuarios registrados en la aplicación</td>
					</tr>
				</tbody>
			</table>
			<footer>
				<p>
					Copyright &copy; 2020 - SUPPORT ME! TEAM - MOLINA - LóPEZ - LINDAO
				</p>
			</footer>
		</div>
	</body>
</html>