Descargar como PDF, PPTX
![HypermediaHypermedia
GET /vehicles
Headers
Link:
<https://api.domain.com/vehicles?page=1&size=20>;
rel=”next”
Body
[ {...}, {…}, ...] Control links
Byteflair](https://image.slidesharecdn.com/todosobremisapis-v6-150318074815-conversion-gate01/85/Todo-sobre-mis-APIs-23-320.jpg)
Subido porDaniel Cerecedo
Todo sobre mis APIs
El documento presenta un análisis detallado sobre la arquitectura REST y su aplicación con HTTP, enfatizando en la importancia de la separación de responsabilidades y la portabilidad de la interfaz de usuario. Se examinan conceptos como hypermedia, vistas adaptativas y prácticas recomendadas para manejar actualizaciones y concurrencia en servicios. Además, se mencionan especificaciones de APIs como API Blueprint, Swagger y RAML, proporcionando enlaces y herramientas útiles para desarrolladores.
Todo sobre mis APIs
- 2.
- 3.
- 4.
- 5. Separación de responsabilidadesde presentación y procesamiento Portabilidad de la interfaz de usuario Simplicidad del servidor Capacidad de modificar los componentes por separado ServidorCliente Byteflair Arquitectura RESTArquitectura REST Cliente/ServidorCliente/Servidor
- 6. 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 RESTArquitectura REST SinestadoSinestado
- 7. Cliente Elimina total oparcialmente algunas de las interacciones Rendimiento de red Rendimiento percibido por el usuario Cache Servidor Cache Byteflair Arquitectura RESTArquitectura REST CacheableCacheable
- 8. 1.Identificación por URIs 2.Mensajesautodescriptivos 3.Manipulación a través de representaciones 4.HATEOAS Simplicidad Byteflair Arquitectura RESTArquitectura REST InterfazuniformeInterfazuniforme
- 9. Cliente Cada capa soloconoce a su vecina Simplicidad Latencia Cache Servidor Cache Proxy Cache Balanceador Byteflair Arquitectura RESTArquitectura REST PorcapasPorcapas
- 10. Developer UXDeveloper UX Eldesarrollador como destinatario del contenido, no los navegadores Byteflair
- 11. ¿Porqué REST sobreHTTP?¿Porqué REST sobre HTTP? Byteflair “Los límites de mi lenguaje son los límites de mi nundo” Todo el mundo habla HTTP LudwigWittgenstein
- 12. REST sobre HTTPRESTsobre HTTP Separar la representación del recurso de los metadatos de la petición Representación Body→ Metadatos Headers→ Byteflair
- 13. REST sobre HTTPRESTsobre HTTP Utiliza el HTTP Status Code para dar información acerca del resultado de la petición 2xx Ok→ 4xx Elclientehahechoalgomal→ 5xx Elservidorhafallado→ Byteflair
- 14. REST sobre HTTPRESTsobre 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
- 15. REST sobre HTTPRESTsobre HTTP Byteflair Error HTTP Error de negocio Error técnico
- 16.
- 17.
- 18.
- 19. HypermediaHypermedia Modela el dominiodel problema Identificalosrecursosdeldominio Identificalastransicionesdeestadodelsistema Distingueentreestructurainternayloqueexponescomorecurso Byteflair ¡No expongas la base de datos!
- 20. HypermediaHypermedia Recursos del dominio VehiclesDrivers Users Owners Sessions Transiciones de estado Crearrecursos Filtrarrecursos Asignarconductoravehículo Activarsesión:conductor+vehículo Desactivarsesión Byteflair
- 21. HypermediaHypermedia Definir los formatosde representación Mime Types Definir roles para cada control hypermedia Rel Types Convenciones semánticas POST, PUT, GET, DELETE Byteflair
- 22. HypermediaHypermedia 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
- 23. HypermediaHypermedia GET /vehicles Headers Link: <https://api.domain.com/vehicles?page=1&size=20>; rel=”next” Body [ {...},{…}, ...] Control links Byteflair
- 24. HypermediaHypermedia GET /sessions/1374 Body { …. “vehicle”:”https://api.domain.com/vehicles/1”, “driver”:”https://api.domain.com/users/1” } Tambiénson control links. Aplica las convenciones para obtener el significado completo!! Byteflair
- 25. HypermediaHypermedia GET /vehicles/1 Body { …. “owner”:”https://api.domain.com/users/1” } Relationtypes specify the role of the link Byteflair
- 26. HypermediaHypermedia El cliente debedescubrir su nivel de acceso a cada recurso Options Byteflair
- 27. HypermediaHypermedia Convenciones RelTypes,MediaTypes,Methods,StatusCodes Byteflair ..o qué debesaber el desarrollador de antemano Las convenciones se convierten en acoplamiento
- 28.
- 29. HypermediaHypermedia Como proveedor,minimiza elnúmero de cosas que debes saber de antemano sobre un API Byteflair
- 30. HypermediaHypermedia No se consigue desacoplarun cliente de su servidor con magia Byteflair
- 31.
- 32. Vistas adaptativasVistas adaptativas Distintoscontextos de seguridad requieren vistas diferentes sobre los mismos datos Byteflair
- 33.
- 34.
- 35.
- 36.
- 37.
- 38.
- 39.
- 40. Compararlarepresentaciónquellegaconelrecurso existente... Sinosoniguales,rechazar... Actualizaciones & ConcurrenciaActualizaciones& Concurrencia Byteflair Podemos usar el ETAG
- 41.
- 42.
- 43.
- 44.
- 45. Peticiones asíncronasPeticiones asíncronas Scenario Ok Needs Repair Repaired Bajomi control Awaiting Byteflair Loscamionesserevisanregularmenteyseseleccionan parareparación
- 46. Peticiones asíncronasPeticiones asíncronas Scenario Ok Needs Repair Repaired Bajomi control Awaiting PUT/trucks/6/repair 202Accepted Byteflair Loscamionesserevisanregularmenteyseseleccionan parareparación
- 47.
- 48.
- 49.
- 50. SpeakinginsilverSpeakinginsilver i18ni18n GET /i18n/es_ES Body { “country” :“ES”, “lang”: “es”, “data” : { “key”: “localized message”, ….} } Byteflair
- 51.
- 52. Byteflair APIAPI BlueprintBlueprint APIAPI SpecificationSpecification Apiary.io Primeraversión: Abril 2013 Objetivos: Simplicidad Interacción y dialogo entre desarrolladores y consumidores
- 53. Byteflair APIAPI BlueprintBlueprint APIAPI SpecificationSpecification Apiaryeditor: https://app.apiary.io Editor local: Atom + Snowcrash + Aglio + Atom plugin
- 54.
- 55. Byteflair APIAPI BlueprintBlueprint APIAPI SpecificationSpecification Gist: https://gist.github.com/victorhernandezbermejo/9d5a9448a487a71dd503 Blueprint: http://docs.bfphonebook.apiary.io/
- 56. Byteflair APIAPI BlueprintBlueprint APIAPI SpecificationSpecification Enlaces: Sitioweb: 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
- 57. Byteflair APIAPI BlueprintBlueprint APIAPI SpecificationSpecification Algunasherramientas 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
- 58. Byteflair SwaggerSwagger APIAPI SpecificationSpecification 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.
- 59. Byteflair SwaggerSwagger APIAPI SpecificationSpecification Swagger editor: http://editor.swagger.io/ Enlocal: https://github.com/Byteflair/docker-swagger-editor docker pull byteflair/swagger-editor docker run -d -p <port>:9000 byteflair/swagger-editor
- 60. Byteflair SwaggerSwagger APIAPI SpecificationSpecification Enlaces: Sitio web: http://swagger.io/ Engithub: https://github.com/swagger-api Especificación del lenguaje: https://github.com/swagger-api/swagger-spec
- 61.
- 62. Byteflair SwaggerSwagger APIAPI SpecificationSpecification Gist :https://gist.github.com/victorhernandezbermejo/efd8093ec45db46836cf
- 63. Byteflair RAMLRAML APIAPI SpecificationSpecification 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.
- 64. Byteflair RAMLRAML APIAPI SpecificationSpecification API Designer: http://api-portal.anypoint.mulesoft.com/raml/api-designer ImagenDocker: https://github.com/Byteflair/docker-raml-editor docker pull byteflair/raml-editor docker run -d -p <port>:9013 byteflair/raml-editor
- 65. Byteflair RAMLRAML APIAPI SpecificationSpecification Enlaces: Sitio web: http://raml.org/ Engithub: https://github.com/raml-org Especificación del lenguaje: https://github.com/raml-org/raml-spec
- 66.
- 67. Byteflair RAMLRAML APIAPI SpecificationSpecification Gist :https://gist.github.com/victorhernandezbermejo/f5db381cb4cf395f47d1
- 68. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Comunidad deusuarios + 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
- 69. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Comunidad deusuarios + Watch Star Fork Questions Apiary Blueprint 115 1,891 561 489 Swagger 221 2,482 822 1,541 RAML 96 1,080 77 120
- 70. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML +
- 71. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje
- 72. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje Mock server
- 73. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje Mock server Reutilización de código
- 74. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje Mock server Reutilización de código Expresividad
- 75. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje Mock server Reutilización de código Expresividad Concisión
- 76. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje Mock server Reutilización de código Expresividad Concisión Herramientas
- 77. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje Mock server Reutilización de código Expresividad Concisión Herramientas Documentación
- 78. Byteflair ComparativaComparativa APIAPI SpecificationSpecification Apiary BlueprintSwagger RAML + Curva de aprendizaje Mock server Reutilización de código Expresividad Concisión Herramientas Documentación Total 27 27 35
- 79.
- 80.
- 81.
- 82.
- 83. “Las armas debenadaptarse a tus cualidades personales y debes ser capaz de manejarlas” Miyamoto Mushashi Byteflair
- 84. ?ThanksThanks GraciasGracias http://byteflair.com Daniel Cerecedo @dcerecedo VictorHernandez @uvehachebe