Todo sobre mis APIs

Transcript

2. Agenda Agenda Arquitectura Arquitectura REST Developer UX REST sobre HTTP Hypermedia APIs Vistas Adaptativas Actualizaciones & Concurrencia I18n Lenguajes de especificación Herramientas de prueba Byteflair
3. Arquitectura Arquitectura Byteflair
4. Separación de responsabilidades de presentación y procesamiento  Portabilidad de la interfaz de usuario  Simplicidad del servidor  Capacidad de modificar los componentes por separado Servidor Cliente Byteflair Arquitectura REST Arquitectura REST Cliente/Servidor Cliente/Servidor
5. Servidor Mensajes autodescriptivos: semántica, datos, metadatos y contexto Cliente2:Cliente Cliente1:Cliente  Visibilidad  Fiabilidad  Escalabilidad  Rendimiento de red  Control sobre el comportamiento del cliente Byteflair Arquitectura REST Arquitectura REST Sin estado Sin estado
6. Cliente Elimina total o parcialmente algunas de las interacciones  Rendimiento de red  Rendimiento percibido por el usuario Cache Servidor Cache Byteflair Arquitectura REST Arquitectura REST Cacheable Cacheable
7. 1.Identificación por URIs 2.Mensajes autodescriptivos 3.Manipulación a través de representaciones 4.HATEOAS  Simplicidad Byteflair Arquitectura REST Arquitectura REST Interfaz uniforme Interfaz uniforme
8. Cliente Cada capa solo conoce a su vecina  Simplicidad  Latencia Cache Servidor Cache Proxy Cache Balanceador Byteflair Arquitectura REST Arquitectura REST Por capas Por capas
9. Developer UX Developer UX El desarrollador como destinatario del contenido, no los navegadores Byteflair
10. ¿Porqué REST sobre HTTP? ¿Porqué REST sobre HTTP? Byteflair “Los límites de mi lenguaje son los límites de mi nundo” Todo el mundo habla HTTP Ludwig Wittgenstein
11. REST sobre HTTP REST sobre HTTP Separar la representación del recurso de los metadatos de la petición Representación Body → Metadatos Headers → Byteflair
12. REST sobre HTTP REST sobre HTTP Utiliza el HTTP Status Code para dar información acerca del resultado de la petición 2xx Ok → 4xx El cliente ha hecho algo mal → 5xx El servidor ha fallado → Byteflair
13. REST sobre HTTP REST sobre HTTP Utiliza los HTTP Status Codes existentes que mejor se adapten a la situación Añade información específica cuando se produzca un error Byteflair
14. REST sobre HTTP REST sobre HTTP Byteflair Error HTTP Error de negocio Error técnico
15. Hypermedia Hypermedia Byteflair
16. Hypermedia Hypermedia Byteflair
17. Hypermedia Hypermedia Byteflair
18. Hypermedia Hypermedia Modela el dominio del problema Identifica los recursos del dominio Identifica las transiciones de estado del sistema Distingue entre estructura interna y lo que expones como recurso Byteflair  ¡No expongas la base de datos!
19. Hypermedia Hypermedia Recursos del dominio Vehicles Drivers Users Owners Sessions Transiciones de estado Crear recursos Filtrar recursos Asignar conductor a vehículo Activar sesión: conductor + vehículo Desactivar sesión Byteflair
20. Hypermedia Hypermedia Definir los formatos de representación Mime Types Definir roles para cada control hypermedia Rel Types Convenciones semánticas POST, PUT, GET, DELETE Byteflair
21. Hypermedia Hypermedia GET / Headers Link: <https://api.domain.com/vehicles>; rel=”vehicles”: <https://api.domain.com/users>; rel=”users”: <https://api.domain.com/sessions>; rel=”sessions” Body ... Byteflair
22. Hypermedia Hypermedia GET /vehicles Headers Link: <https://api.domain.com/vehicles?page=1&size=20>; rel=”next” Body [ {...}, {…}, ...] Control links Byteflair
23. Hypermedia Hypermedia GET /sessions/1374 Body { …. “vehicle”:”https://api.domain.com/vehicles/1”, “driver”:”https://api.domain.com/users/1” } También son control links. Aplica las convenciones para obtener el significado completo!! Byteflair
24. Hypermedia Hypermedia GET /vehicles/1 Body { …. “owner”:”https://api.domain.com/users/1” } Relation types specify the role of the link Byteflair
25. Hypermedia Hypermedia El cliente debe descubrir su nivel de acceso a cada recurso Options Byteflair
26. Hypermedia Hypermedia Convenciones Rel Types, Media Types, Methods, Status Codes Byteflair ..o qué debe saber el desarrollador de antemano Las convenciones se convierten en acoplamiento
27. Hypermedia Hypermedia Byteflair HAL HAL http://stateless.co/hal_specification.html
28. Hypermedia Hypermedia Como proveedor, minimiza el número de cosas que debes saber de antemano sobre un API Byteflair
29. Hypermedia Hypermedia No se consigue desacoplar un cliente de su servidor con magia Byteflair
30. Vistas adaptativas Vistas adaptativas Byteflair
31. Vistas adaptativas Vistas adaptativas Distintos contextos de seguridad requieren vistas diferentes sobre los mismos datos Byteflair
32. Un administrador debe poder ver todos los datos de un usuario Un usuario puede ver todos sus datos Un usuario solo puede ver los datos públicos de los demás usuarios Scenario Byteflair Vistas adaptativas Vistas adaptativas
33. /users/{id} /owner/users/{id} /admin/users/{id} Una URI por cada rol de seguridad Scenario Byteflair Vistas adaptativas Vistas adaptativas
34. Descomponer el recurso Dar diferentes niveles de acceso a cada recurso Scenario /users/{id} /users/{id}/my-private-data /users/{id}/data-about-me-only-the-admin-knows Byteflair Vistas adaptativas Vistas adaptativas
35. Un único recurso Múltiples vistas sobre el mismo recurso Seleccionamos la vista en runtime Scenario /users/{id} Byteflair Vistas adaptativas Vistas adaptativas
36. Actualizaciones & Concurrencia Byteflair
37. Dos clientes tratan de actualizar el mismo recurso de forma concurrente La representación es el estado de la aplicación Debemos evitar que la segunda petición actualice el recurso a partir de una representación obsoleta Actualizaciones & Concurrencia Actualizaciones & Concurrencia Scenario Byteflair
38. Comparar la representación que llega con el recurso existente... Actualizaciones & Concurrencia Actualizaciones & Concurrencia Byteflair
39. Comparar la representación que llega con el recurso existente... Si no son iguales, rechazar... Actualizaciones & Concurrencia Actualizaciones & Concurrencia Byteflair Podemos usar el ETAG
40. Comparar la representación que llega con el recurso existente... Si no son iguales, rechazar... Si es posible, informar al cliente de las violaciones Actualizaciones & Concurrencia Actualizaciones & Concurrencia Byteflair
41. Peticiones asíncronas Peticiones asíncronas Byteflair
42. Como identificamos peticiones intrínsecamente asíncronas? Existen transiciones de estado fuera del control del cliente No tiene sentido devolver una representación por que no conocemos el estado del recurso tras la llamada Byteflair Peticiones asíncronas Peticiones asíncronas
43. Peticiones asíncronas Peticiones asíncronas Scenario Ok Needs Repair Repaired Awaiting Byteflair Los camiones se revisan regularmente y se seleccionan para reparación
44. Peticiones asíncronas Peticiones asíncronas Scenario Ok Needs Repair Repaired Bajo mi control Awaiting Byteflair Los camiones se revisan regularmente y se seleccionan para reparación
45. Peticiones asíncronas Peticiones asíncronas Scenario Ok Needs Repair Repaired Bajo mi control Awaiting PUT /trucks/6/repair 202 Accepted Byteflair Los camiones se revisan regularmente y se seleccionan para reparación
46. Si existen peticiones que consumen mucho tiempo... Byteflair Peticiones asíncronas Peticiones asíncronas
47. Si existen peticiones que consumen mucho tiempo... las hacemos asíncronas! Byteflair Peticiones asíncronas Peticiones asíncronas
48. Speaking in silver Speaking in silver i18n i18n Byteflair
49. Speaking in silver Speaking in silver i18n i18n GET /i18n/es_ES Body { “country” : “ES”, “lang”: “es”, “data” : { “key”: “localized message”, ….} } Byteflair
50. Byteflair API API Specification Specification
51. Byteflair API API Blueprint Blueprint API API Specification Specification Apiary.io Primera versión: Abril 2013  Objetivos:  Simplicidad  Interacción y dialogo entre desarrolladores y consumidores
52. Byteflair API API Blueprint Blueprint API API Specification Specification Apiary editor: https://app.apiary.io Editor local: Atom + Snowcrash + Aglio + Atom plugin
53. Byteflair API API Blueprint Blueprint API API Specification Specification Ejemplo
54. Byteflair API API Blueprint Blueprint API API Specification Specification Gist  : https://gist.github.com/victorhernandezbermejo/9d5a9448a487a71dd503 Blueprint: http://docs.bfphonebook.apiary.io/
55. Byteflair API API Blueprint Blueprint API API Specification Specification Enlaces:  Sitio web: https://apiblueprint.org/  En github: https://github.com/apiaryio/api-blueprint  Especificación del lenguaje: https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md
56. Byteflair API API Blueprint Blueprint API API Specification Specification Algunas herramientas Apiary: http://apiary.io Dredd: https://github.com/apiaryio/dredd Drakov: https://www.npmjs.com/package/drakov Dredd: https://github.com/apiaryio/dredd Aglio: https://github.com/danielgtaylor/aglio
57. Byteflair Swagger Swagger API API Specification Specification Reverb Primera versión: Julio 2011 Objetivos:  En un principio documentación de APIs ya existentes.  En su versión 2.0 cambiaron el enfoque hacia el diseño y la especificación.
58. Byteflair Swagger Swagger API API Specification Specification Swagger editor: http://editor.swagger.io/ En local: https://github.com/Byteflair/docker-swagger-editor docker pull byteflair/swagger-editor docker run -d -p <port>:9000 byteflair/swagger-editor
59. Byteflair Swagger Swagger API API Specification Specification Enlaces:  Sitio web: http://swagger.io/  En github: https://github.com/swagger-api  Especificación del lenguaje: https://github.com/swagger-api/swagger-spec
60. Byteflair Swagger Swagger API API Specification Specification Ejemplo
61. Byteflair Swagger Swagger API API Specification Specification Gist  : https://gist.github.com/victorhernandezbermejo/efd8093ec45db46836cf
62. Byteflair RAML RAML API API Specification Specification Mulesoft Primera versión: Septiembre 2013 Objetivos:  Dar un mayor peso a la especificación del API  Poder obtener información de todos los actores involucrados lo antes posible.
63. Byteflair RAML RAML API API Specification Specification API Designer: http://api-portal.anypoint.mulesoft.com/raml/api-designer Imagen Docker: https://github.com/Byteflair/docker-raml-editor docker pull byteflair/raml-editor docker run -d -p <port>:9013 byteflair/raml-editor
64. Byteflair RAML RAML API API Specification Specification Enlaces:  Sitio web: http://raml.org/  En github: https://github.com/raml-org  Especificación del lenguaje: https://github.com/raml-org/raml-spec
65. Byteflair RAML RAML API API Specification Specification Ejemplo
66. Byteflair RAML RAML API API Specification Specification Gist  : https://gist.github.com/victorhernandezbermejo/f5db381cb4cf395f47d1
67. Byteflair Comparativa Comparativa API API Specification Specification Comunidad de usuarios   +  Watch  Star  Fork  Questions Apiary Blueprint 115 1,891 561 489 Swagger 221 2,482 822 1,541 RAML 96 1,080 77 120 Datos a fecha 16/03/2015
68. Byteflair Comparativa Comparativa API API Specification Specification Comunidad de usuarios   +  Watch  Star  Fork  Questions Apiary Blueprint 115 1,891 561 489      Swagger 221 2,482 822 1,541      RAML 96 1,080 77 120     
69. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +               
70. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje               
71. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje                Mock server               
72. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje                Mock server                Reutilización de código               
73. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje                Mock server                Reutilización de código                Expresividad               
74. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje                Mock server                Reutilización de código                Expresividad                Concisión               
75. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje                Mock server                Reutilización de código                Expresividad                Concisión                Herramientas               
76. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje                Mock server                Reutilización de código                Expresividad                Concisión                Herramientas                Documentación               
77. Byteflair Comparativa Comparativa API API Specification Specification Apiary Blueprint Swagger RAML   +                Curva de aprendizaje                Mock server                Reutilización de código                Expresividad                Concisión                Herramientas                Documentación                Total 27  27  35 
78. Byteflair API API Specification Specification Conclusiones Conclusiones
79. Byteflair Tools Tools Demo Demo
80. Byteflair Tools Tools Links Links Postman: http://www.getpostman.com/ Runscope: https://www.runscope.com/ Soap UI: http://www.soapui.org/
81. Byteflair Tools Tools Gists Gists Gist  : https://gist.github.com/victorhernandezbermejo/854271c55cba55749c1d
82. “Las armas deben adaptarse a tus cualidades personales y debes ser capaz de manejarlas” Miyamoto Mushashi Byteflair
83. ? Daniel Cerecedo @dcerecedo Thanks Thanks Gracias Gracias Victor Hernandez @uvehachebe