-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathProtocoloHTTP-REST.txt
557 lines (365 loc) · 9.55 KB
/
ProtocoloHTTP-REST.txt
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
//////////
// HTTP //
//////////
El protocolo http consiste en...
En un servidor remoto hay una serie de recursos organizados en carpetas reales o imaginarias
Los clientes envian peticiones para trabar con dichos recursos
Las peticiones consisten en una ruta que identifique a uno o varios recursos y un método que le indique
al servidor la operación que debe realizar
Una ruta puede identificar
-una carpeta: todos los recursos contenidos en ella
-un recurso concreto
-un subconjunto de los recursos contenidos en una carpeta
METODO + URL/RUTA
MÉTODOS HTTP
--------------------------------------------------
Métodos relacionados directamente con los recursos
GET Solicita al servidor que entregue los recursos identificados por la ruta. No tiene body. Es idempotente
POST Solicita al servidor que añada un recurso en una carpeta. El recurso irá en el body de la petición
PUT Solicita al servidor que sustituya el recurso identificado por la ruta por el que va adjunto en el body
PATCH Solicita al servidor que modifique el recurso identificado por la ruta con los datos contenidos en el body
DELETE Solicita al servidor que elimine el recurso o recursos identificados por la ruta. No tiene body
--------------------------------------------------
Otros métodos para otras historas
HEAD
OPTIONS
/////////////////////////
//GET, RECURSOS FISICOS//
/////////////////////////
RECURSOS
pagina1.html
pagina2.html
MOVIDAS
pagina3.html
pagina4.html
Petición
GET /movidas/pagina3.html
Respuesta
200 OK
Content-type: text/html
----------------------------
<html>
GET /movidas
////////////////////////
// //
// REST //
// //
////////////////////////
Diseñando un API REST
Representational State Transfer
-Identificar los recursos. Los recursos serán representaciones de las entidades que afectan al servicio
-Definir la representación de los recursos
-Definir las carpetas para los recursos
-Definir cuales peticiones conforman el API
/clientes
cli-0001
cli-0002
cli-0004
/////////
// GET //
/////////
Las rutas asociadas a peticiones GET pueden acabar en un recurso concreto o en una carpeta
Peticion:
GET /clientes/cli-0002 -> dame el cliente cli-0002
Respuesta
200 OK
Content-Type: app/json
----------------------
{ cliente }
Petición:
GET /clientes/cli-0003
Respuesta
404 Not found
Content-Type: app/json
----------------------
{ codigo:404, mensaje:"El cliente no existe" }
Peticion:
GET /clientes
Respuesta
200 OK
Content-Type: app/json
----------------------
[ { cli1 }, { cli2 }, { cli3 }... ]
//////////
// POST //
//////////
Las rutas asociadas a las peticiones POST acaban siempre en carpeta
POST /clientes
CT: app/json
------------------------
{ cliente }
201 Created
CT: app/json
------------------------
{ id : 67 }
ó
{ cliente }
/////////
// PUT //
/////////
Las rutas asociadas a peticiones PUT pueden acabar en un recurso concreto o en una carpeta (mucho cuidado con los 'bulk update')
Tenemos este cliente en el servidor (en la bb.dd)
{
id : 42
nombre : "Fulanito",
direccion : "C/Falsa, 123",
telefono : "123 456 789",
correoE : "a@b.c"
}
Petición:
PUT /clientes/42 <--Es obligatorio que el id esté en la ruta
CT: app/json
------------------------
{
id : 42 <--Esta propiedad es opcional porque ya está en la ruta. En el servidor debe ser ignorada ACTIVAMENTE
nombre : "Fulanito",
direccion : "C/Falsa, 123",
telefono : "555 555 555", <-----
correoE : "a@b.c"
}
El cliente quedaría así:
{
id : 42
nombre : "Fulanito",
direccion : "C/Falsa, 123",
telefono : "555 555 555",
correoE : "a@b.c"
}
Peticion:
PUT /clientes/42
CT: app/json
------------------------
{
telefono : "555 555 555"
}
El cliente quedaría así:
{
id : 42
nombre : null, <--F
direccion : null, <--F
telefono : "555 555 555",
correoE : null <--F
}
///////////
// PATCH //
///////////
Las rutas asociadas a peticiones PATHC pueden acabar en un recurso concreto o en una carpeta (mucho cuidado con los 'bulk update')
Tenemos este cliente en el servidor (en la bb.dd)
{
id : 42
nombre : "Fulanita",
direccion : "C/Falsa, 123",
telefono : "123 456 789",
correoE : "a@b.c"
}
Petición:
PATCH /clientes/42 <--Es obligatorio que el id esté en la ruta
CT: app/json
------------------------
{
id : 42 <--Esta propiedad es opcional porque ya está en la ruta. En el servidor debe ser ignorada ACTIVAMENTE
nombre : "Fulanita",
direccion : "C/Falsa, 123",
telefono : "555 555 555", <-----
correoE : "a@b.c"
}
El cliente quedaría así:
{
id : 42
nombre : "Fulanita",
direccion : "C/Falsa, 123",
telefono : "555 555 555",
correoE : "a@b.c"
}
Peticion:
PUT /clientes/42
CT: app/json
------------------------
{
telefono : "555 555 555"
}
El cliente quedaría así:
{
id : 42
nombre : "Fulanita",
direccion : "C/Falsa, 123",
telefono : "555 555 555",
correoE : "a@b.c"
}
Se puede definir una petición que no incuya el identificador del recurso, pero es muy peligroso
PATCH /clientes
CT: app/json
--------------------------
{ estado : "activo" }
////////////
// DELETE //
////////////
Las rutas asociadas a peticiones DELETE pueden acabar en un recurso concreto o en una carpeta (mucho cuidado con los 'bulk delete')
Petición
DELETE /clientes/87 -> borra el cliente 87
Respuesta
200 OK
CT: app/json
-------------------------
{ mensaje : "El cliente se ha borrado" }
Petición:
DELETE /clientes -> Borra todos los clientes!
Respuesta
200 OK
CT: app/json
--------------------------
{ mensaje : "Estarás contento..." }
O MEJOR:
404 Not found
CT: app/json
--------------------------
{ mensaje : "Funcionalidad no implementada" }
//API REST para la AGENDA
MÉTODO URL BODY FUNCIONALIDAD
GET /personas - listar las personas
GET /personas/{id} - buscar a una persona por su id
POST /personas {json} insertar la persona
PUT /personas/{id} {json} modificar la persona
DELETE /personas/{id} - borrar una persona
///////////////////////////////
// RELACIONES ENTRE RECURSOS //
///////////////////////////////
-Cardinalidad de las relaciones:
//
//UNO A UNO
//
1..1 : paciente - historial médico
//
//UNO A MUCHOS
//
1..n, 1..* : cliente - factura
Uno a muchos, la factura no tiene la relación con el cliente
Cliente Factura
{ {
id : id :
nombre : codigo :
direccion : fecha :
telefono : formaPago :
facturas : [ fra1, fra2... ] }
}
Uno a muchos, el cliente no tiene el array de facturas (la más común)
Cliente Factura
{ {
id : id :
nombre : codigo :
direccion : fecha :
telefono : formaPago :
} cliente : { id }
}
Uno a muchos, BIDIRECCIONAL
Cliente Factura
{ {
id : id :
nombre : codigo :
direccion : fecha :
telefono : formaPago :
facturas : [ fra1, fra2... ] cliente : { id }
} }
//
//MUCHOS A MUCHOS. Normalmente no se usan
//
n..m, *..* : pelicula - actor
pedido - producto
Pelicula Actor
{ {
id : id :
titulo : nombre :
director : fechaNac :
genero : pais
year : peliculas : [ p1, p2, p3 ]
actores : [ a1, a2, a3 ] }
}
//
//Entidad intermedia (muchos a muchos)
//
Necesitamos una entidad intermedia y al final tenemos
Pelicula --1..n-- Actuación --n..1-- Actor
Pelicula Actuación Actor
{ { {
id : id : id :
titulo : papel : nombre :
director : premio : fechaNac :
genero : pelicula : { id } pais :
year : actor : { id } actuaciones : [ a1, a2, a3 ]
actuaciones : [ a1, a2, a3 ] } }
}
/clientes
cli-0001
cli-0002
cli-0004
/facturas
fra-1
fra-2
fra-3
fra-4
fra-5
fra-6
fra-7
////////////////////////////////////////////////////////////////
/clientes
/cli-0001
cli-0001
/facturas
fra-1
fra-3
fra-5
/pedidos
ped-0
ped-1
/incidencias
inc-1
/cli-0002
cli-0002
/facturas
fra-2
fra-5
/cli-0003
cli-0003
/facturas
fra-4
fra-7
GET /clientes -> dame todos los clientes
GET /clientes/2 -> dame el cliente 2
GET /clientes/2/facturas -> dame las facturas del cliente 2
Esto está mal. El método afecta a lo que haya al final de la ruta:
//...
GET /facturas/clientes/2
Dame las peliculas del director 50
GET /directores/50/peliculas
A las relaciones 1..n no se les puede 'dar la vuelta':
GET /clientes/5/facturas
GET /facturas/5/clientes :(
Pero a las relaciones de n..m si:
GET /peliculas/50/actores
GET /actores/50/peliculas - ámbia el sentido, pero sigue teniendolo
/////////////////////////////////////////////////
// FILTRADO DE RESULTADOS CON LOS QUERY PARAMS //
/////////////////////////////////////////////////
GET /clientes
Opciones:
-devolver los 15.000.000 de clientes
-devolver los, p.e., los 50 primeros
-paginar el resultado
-404: No atendender dicha petición
Los query parameters se adjuntan a la url después de una'?'
Son pares clave-valor y la sintaxis es:
GET /recursos?param1=valor1¶m2=valor2¶m3=valor3
Pueden admitir varios valores
param=valor1,valor2,valor3
Tambien es legal un parámetro sin valor
Dame los clientes de chinchon:
|
GET /clientes?ciudad=Chinchón
|
Dame las facturas del cliente 47:
GET /clientes/47/facturas
Es equivalente a: GET /facturas?idCliente=47 <----
Dame las peliculas del director 50:
GET /peliculas?idDirector=50
//
//Otro día seguimos...