How I met your API

Transcript

1. how i met your API víctor hernández API Days May 6, 2015 Byteflair
2. Víctor Hernández  @uvehachebe  victor.hernandez@byteflair.com how i met your API
3. aim Byteflair how i met your API
4. aim  why?  how?  API Specification  API Documentation Byteflair how i met your API
5. why? Byteflair how i met your API
6. front-end back-end API Byteflair how i met your API API
7. front-end back-end versioning validation uptime maintenance caching security TTFHW support examples latency debugging API Byteflair how i met your API
8. front-end back-end rails java scala erlang versioning validation uptime maintenance caching security TTFHW support examples latency debugging js PHP jQuery angular Android iOS API Byteflair how i met your API
9. Design some weeks Byteflair how i met your API Design
10. Design some weeks Byteflair how i met your API Design Implementation
11. Design Cstomer some weeks some months Byteflair how i met your API Design Implementation Customer
12. Design Cstomer some weeks some months Byteflair how i met your API Design Implementation Customer
13. Customer Byteflair how i met your API Design Implementation Customer
14. Design Implementation Customer back-end developers front-end developers Byteflair how i met your API
15. front-end developers back-end developers Documentation Byteflair how i met your API contract
16. front-end developers back-end developers Documentation mock Byteflair how i met your API contract
17. front-end developers back-end developers Documentation mock test Byteflair how i met your API contract
18. how? Byteflair how i met your API
19. how? API Specification Byteflair how i met your API
20. Byteflair how i met your API API Blueprint Apiary.io Primera versión: Abril 2013  Objetivos:  Simplicidad  Interacción y dialogo entre desarrolladores y consumidores
21. Byteflair how i met your API API Blueprint Apiary editor: https://app.apiary.io Editor local: Atom + Snowcrash + Aglio + Atom plugin
22. Byteflair how i met your API API Blueprint example Gist  : https://gist.github.com/victorhernandezbermejo/9d5a9448a487a71dd503 Blueprint: http://docs.bfphonebook.apiary.io/
23. Byteflair how i met your API API Blueprint Links:  Blueprint website: https://apiblueprint.org/  Github: https://github.com/apiaryio/api-blueprint  Language specification: https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md
24. Byteflair how i met your API API Blueprint Tools Apiary: http://apiary.io Drakov: https://www.npmjs.com/package/drakov Dredd: https://github.com/apiaryio/dredd Aglio: https://github.com/danielgtaylor/aglio
25. Byteflair how i met your API Swagger 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.
26. Byteflair how i met your API Swagger 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. Smart Bear
27. Byteflair how i met your API Swagger Swagger editor: http://editor.swagger.io/ Editor local: https://github.com/Byteflair/docker-swagger-editor docker pull byteflair/swagger-editor docker run -d -p <port>:9000 byteflair/swagger-editor
28. Byteflair how i met your API Swagger example Gist  : https://gist.github.com/victorhernandezbermejo/efd8093ec45db46836cf
29. Byteflair how i met your API Swagger Links:  Swagger website: http://swagger.io/  Github: https://github.com/swagger-api  Language specification: https://github.com/swagger-api/swagger-spec
30. Byteflair how i met your API Swagger Tools Swagger (mock) server: https://www.npmjs.com/package/swagger-server Grunt-swagger-tools (for Swagger validation): https://www.npmjs.com/package/grunt-swagger-tools
31. Byteflair how i met your API RAML 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.
32. Byteflair how i met your API RAML 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
33. Byteflair how i met your API RAML Gist  : https://gist.github.com/victorhernandezbermejo/f5db381cb4cf395f47d1 example
34. Byteflair how i met your API RAML Links:  RAML website: http://raml.org/  Github: https://github.com/raml-org  Language specification: https://github.com/raml-org/raml-spec
35. Byteflair how i met your API RAML Tools raml-mockup: https://www.npmjs.com/package/raml-mockup RAML for JAX-RS: https://github.com/mulesoft/raml-for-jax-rs
36. Byteflair how i met your API Visual Paradigm Links:  Modeling REST API: http://www.visual-paradigm.com/...  Examples: https://www.visual-paradigm.com/tutorials/rest-api-example-simple-registration-service.jsp https://www.visual-paradigm.com/tutorials/rest-api-design-twitter-example.jsp
37. updated on May 4, 2015  Watch  Star  Fork  Questions Apiary Blueprint 133 2,114 612 526 Swagger 218 2,571 1,480 1,796 RAML 105 1,169 87 150 VP (REST) - - - 0 Comunidad de usuarios:   + Byteflair how i met your API
38. Byteflair how i met your API Apiary Blueprint Swagger RAML   +   
39. Byteflair how i met your API Apiary Blueprint Swagger RAML   +    Curva de aprendizaje   
40. Byteflair how i met your API Apiary Blueprint Swagger RAML   +    Curva de aprendizaje    Mock server   
41. Byteflair how i met your API Apiary Blueprint Swagger RAML   +    Curva de aprendizaje    Mock server    Reutilización de código   
42. Byteflair how i met your API Apiary Blueprint Swagger RAML   +    Curva de aprendizaje    Mock server    Reutilización de código    Expresividad y concisión   
43. Byteflair how i met your API Apiary Blueprint Swagger RAML   +    Curva de aprendizaje    Mock server    Reutilización de código    Expresividad y concisión    Herramientas   
44. Byteflair how i met your API Apiary Blueprint Swagger RAML   +    Curva de aprendizaje    Mock server    Reutilización de código    Expresividad y concisión    Herramientas    Documentación   
45. how? API Documentation Byteflair how i met your API
46. Byteflair how i met your API 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. Smart Bear Swagger Documentation generation
47. Byteflair how i met your API Swagger Documentation generation Generación de documentación en base a anotaciones en el código: https://github.com/swagger-api/swagger-core/wiki/Annotations @ApiParam @ApiResponse @ApiResponses @Authorization @AuthorizationScope @Api @ApiImplicitParam @ApiImplicitParams @ApiModel @ApiModelProperty @ApiOperation
48. Byteflair how i met your API apiDoc Documentation generation Generación de documentación en base a anotaciones en los comentarios: http://apidocjs.com/ @apiName @apiParam @apiParamExample @apiPermission @apiSampleRequest @apiSuccess @apiSuccessExample @apiUse @apiVersion @api @apiDefine @apiDescription @apiError @apiErrorExample @apiExample @apiGroup @apiHeader @apiHeaderExample @apiIgnore
49. updated on May 4, 2015  Watch  Star  Fork  Questions Apiary Blueprint 133 2,114 612 526 Swagger 218 2,571 1,480 1,796 RAML 105 1,169 87 150 VP (REST) - - - 0 apiDoc 48 974 190 2,962 Comunidad de usuarios:   + Byteflair how i met your API
50. recap  why?  how?  API Specification  API Documentation Byteflair how i met your API
51. recap  why?  how?  API Specification  API Documentation Byteflair how i met your API Specification = Contract mock test
52. recap  why?  how?  API Specification  API Documentation Byteflair how i met your API Specification = Contract mock test API Blueprint RAML Visual Paradigm Swagger
53. recap  why?  how?  API Specification  API Documentation Byteflair how i met your API Specification = Contract mock test API Blueprint RAML Visual Paradigm Swagger apiDoc
54. thank you Byteflair Víctor Hernández  @uvehachebe  victor.hernandez@byteflair.com how i met your API