RESTful 4 all. Diego Sapriza

Transcripción

1 RESTful 4 all Diego Sapriza

2 Como diseñar una API RESTful sin morir en el intento.

3 Hi! I M Diego

4

5 ..uy PHP.meetup.uy DevOps.meetup.uy

6 El mundo evoluciona constantemente

7 Restful api versionamiento recursos status codes autenticación mensajes paginación documentación! hypermedia (HATEOAS) verbos tools

8 Quiénes hacen mayoritariamente Web dev?

9 REpresentational State transfer no es un estándar

10 Acuerdo

11

12 Roy Fielding escalabilidad :(

13 restricciones escalabilidad Client-Server Stateless Cache Uniform Interfaces Layered System Code on demand (opcional)

14 Richardson Maturity Model

15 0: The Swamp of POX RPC SOBRE HTTP

16 JSON XML html images

17 0: The Swamp of POX GET harvest/end- job/:id/ errors/:errors_messages harvest/start- job/:id

18 Richardson Maturity Model

19 Uniform Interfaces Identificación recursos. Manipulación de recursos a través de su representación. Mensajes auto-descriptivos. Hypermedia como motor del estado de la aplicación (HATEOAS).

20 1: RECURSOS tienen una URI mapean entidad/es sustantivos

21 uri scheme:hierarchical part[?query][#fragment] telnet:// urn:isbn:

22 identificación /recurso/:id /recurso/:id/:acción! /?r=recurso&id=:id /?r=recurso&id=:id&a=:acción

23 colecciones /recursos /recursos/:id /recursos/:id?pagina=:n&limite=100

24 Richardson Maturity Model

25 Uniform Interfaces Identificación recursos. Manipulación de recursos a través de su representación.! Mensajes auto-descriptivos. Hypermedia como motor del estado de la aplicación (HATEOAS).

26 Representación

27 HTTP verbs Get Post Put Delete Patch Options Head Trace Connect request- methods

28 crud http CREATE READ UPDATE DELETE POST GET PUT DELETE

29 método seguro idempotente cachable GET HEAD POST PUT DELETE

30 GET /personas Obtener lista de personas POST /personas Agregar una persona DELETE /personas/:id Eliminar una persona GET /personas/:id Obtener una persona PUT /personas/:id Actualizar una persona GET POST /personas/:id/contactos /personas/:id/contactos Obtener los contactos de una persona Agregar un contacto a una persona POST /personas/subirimagen Subir una imagen

31 y ahora qué hacemos con estos msjs?

32 Richardson Maturity Model

33 Documentar

34 Uniform Interfaces Identificación recursos. Manipulación de recursos a través de su representación. Mensajes auto-descriptivos.! Hypermedia como motor del estado de la aplicación (HATEOAS).

35 auto-descriptivos Cómo procesar el mensaje? qué parser utilizar? Caching?

36 ahora cómo son los mensajes? HAL Collection JSON Siren

37 HTTP/ OK! Content-Type: application/json! {! "status":"ok",! "message":"data retrieved OK!",! "data" : [!!{!! "id": 90,!! "modelid": 81,!! "path": "Somewhere over the rainbow.rvt"!!},!!{!! "id": 91,!! "modelid": 13,!! "path": "Blue birds fly.rvt! }]! }! GET harvest/get- jobs/ o_o

38 HTTP/ OK! Content-Type: application/json! {! "status":"error",! "message":"page not found,! "data" : []! }! o_o

39 status codes 2xx - Success 3xx - Redirection 4xx - Client Error 5xx - Server Error

40 Error messages api-problem HTTP/ Unauthorized! Content-Type: application/problem+json! {!! "type": " "title": "Unauthorized",!! "status": 401,!! "detail": "Unauthorized",!! "authentication_uri": "/oauth"! }!

41 Uniform Interfaces Identificación recursos. Manipulación de recursos a través de su representación. Mensajes auto-descriptivos. Hypermedia como motor del estado de la aplicación (HATEOAS).

42 HATEOAS Clients make state transitions only through actions that are dynamically identified within hypermedia by the server.! Except for simple fixed entry points to the application, a client does not assume that any particular action is available for any particular resources beyond those described in representations previously received from the server.

43 clase.php public class Customer! {!!!public $Id;!!!public $Name;! }!

44 clase.c# public class Customer! {!! public int Id { get; set; }!! public string Name { get; set; }! }!

45 json {! "id" : "1"! "name" : "Diego"! }!

46 HAL {! "id": "diego",! "name": "Diego Sapriza,!! "_links": {! "self": {! "href": " },! "website": {! "href": " }! }! }!

47 HAL {!.. *snip*..! "_embedded": {! "website": {! "_links": {! "self": {! "href": }! },! "id": "diego",! "url": " }! }! }!

48 HAL - colecciones {! "_links": {! "self" :{ "href": " },! "first":{ "href": " },! "prev" :{ "href": " },! "next" :{ "href": " },! "last" :{ "href": " }! },! "count": 3,! "total": 498,!...! }

49

50 {! "current_user_url": " "authorizations_url": " " s_url": " "emojis_url": " "events_url": " "feeds_url": " "following_url": " "gists_url": " "hub_url": " "issues_url": " "keys_url": " "notifications_url": " "organization_url": " "public_gists_url": " "rate_limit_url": " "repository_url": " "starred_url": " "starred_gists_url": " "team_url": " "user_url": " "user_organizations_url": " }!

51 Richardson Maturity Model

52 Sigamos links

53 Restful api versionamiento! recursos status codes autenticación! mensajes paginación documentación! hypermedia (HATEOAS) verbos tools

54 Versiona tu API

55 HTTP GET

56 HTTP GET api- version: 2

57 HTTP GET Accept: application/vnd.myapi.v2+json

58 HTTP GET por defecto última versión Headers para versiones anteriores

59 autenticación

60 crea tu propio método

61 HTTP Basic Auth HTTP Digest! OAuth2!

62 tools Postman Runscope jsonmate.com

63 Restful api versionamiento recursos status codes paginación documentación! hypermedia (HATEOAS) autenticación mensajes verbos tools

64

65 @AV4TAr

66

67 richardsonmaturitymodel.html