Construyendo APIs

Talk presented at RubyConf Colombia 2016

Video at https://www.youtube.com/watch?v=gX-EIC3izAg

Transcript

1. CONSTRUYENDO APIS NICOLÁS HOCK-ISAZA
2. ¿CÓMO SE COMUNICAN COSAS COMPLETAMENTE NO RELACIONADAS?
3. ¿CÓMO HABLAR CON ALIENS?
4. TENDRÍAMOS QUE RESOLVERLO (SOLOS)
5. ¿MIENTRAS LLEGAMOS A ESO?
6. ¿MIENTRAS LLEGAMOS A ESO? CONOCIMIENTO A PRIORI
7. APIS
9. APIS
10. CONOCIMIENTO COMPARTIDO
11. CONOCIMIENTO COMPARTIDO 1 Mi programa expone una interfaz
12. CONOCIMIENTO COMPARTIDO 1 Mi programa expone una interfaz 2 Un humano documenta esa interfaz
13. CONOCIMIENTO COMPARTIDO 1 Mi programa expone una interfaz 2 Un humano documenta esa interfaz 3 Ernestico lee la documentación
14. CONOCIMIENTO COMPARTIDO 1 Mi programa expone una interfaz 2 Un humano documenta esa interfaz 3 Ernestico lee la documentación 4 Ernestico crea un programa que usa la interfaz
16. CONOCIMIENTO COMPARTIDO
17. CONOCIMIENTO COMPARTIDO 1 Exponer interfaz
18. CONOCIMIENTO COMPARTIDO 1 Exponer interfaz 2 D ocum entación
19. CONOCIMIENTO COMPARTIDO 1 Exponer interfaz 2 D ocum entación 4 Program ar cliente
20. CONOCIMIENTO COMPARTIDO 1 Exponer interfaz 2 D ocum entación 3 Leer docum entación 4 Program ar cliente
21. FLUJO TÍPICO 1 DESARROLLO 2 DESPLIEGUE 4 ANÁLISIS 3 CONSUMO
22. PROBLEMAS
23. PROBLEMAS ▸ Propenso a errores
24. PROBLEMAS ▸ Propenso a errores ▸ Sistema frágil. Múltiples iteraciones
25. PROBLEMAS ▸ Propenso a errores ▸ Sistema frágil. Múltiples iteraciones ▸ Altamente acoplado
26. PROBLEMAS ▸ Propenso a errores ▸ Sistema frágil. Múltiples iteraciones ▸ Altamente acoplado ▸ Waterfall
27. ¿CÓMO MEJORAMOS?
28. 1 DISEÑO 3 DESPLIEGUE 5 ANÁLISIS 4 CONSUMO 2 DESARROLLO DISEÑO A-PRIORI
29. ¿CÓMO MEJORAMOS?
30. PROTOTIPOS
31. 1 DISEÑO Y PROTOTIPO 3 DESPLIEGUE 5 ANÁLISIS 4 CONSUMO 2 DESARROLLO DISEÑO Y PROTOTIPO
32. 1 DISEÑO Y PROTOTIPO 3 DESPLIEGUE 5 ANÁLISIS 4 CONSUMO 2 DESARROLLO DISEÑO Y PROTOTIPO
33. FLUJO @ RIDE
34. DISEÑO Y PROTOTIPO (RFC) ▸ Identificamos recursos
35. DISEÑO Y PROTOTIPO (RFC) ▸ Identificamos recursos ▸ Estados de un recurso
36. DISEÑO Y PROTOTIPO (RFC) ▸ Identificamos recursos ▸ Estados de un recurso ▸ Borradores de contratos
37. DISEÑO Y PROTOTIPO (RFC) ▸ Identificamos recursos ▸ Estados de un recurso ▸ Borradores de contratos ▸ Revisión & Comentarios
39. ¿Y EL PROTOTIPO?
40. API BLUEPRINT
41. API BLUEPRINT
42. API BLUEPRINT
43. API BLUEPRINT
44. API BLUEPRINT
45. API BLUEPRINT
46. MSON ## Invitation Full (object) - id: `100` (string, required) - code: `cheeky-monkey352` (string, required) - links (object, required) - ride: `100` (string, required) - inviter (UserLink) - origin (AddressLink, nullable, optional) - Inviter origin. - destination (AddressLink, nullable, optional) - Inviter destination. MSON: Markdown Syntax Object Notation
47. MSON MSON: Markdown Syntax Object Notation ## Invitation Full (object) - id: `100` (string, required) - code: `cheeky-monkey352` (string, required) - links (object, required) - ride: `100` (string, required) - inviter (UserLink) - origin (AddressLink, nullable, optional) - Inviter origin. - destination (AddressLink, nullable, optional) - Inviter destination.
48. MSON MSON: Markdown Syntax Object Notation ## Invitation Full (object) - id: `100` (string, required) - code: `cheeky-monkey352` (string, required) - links (object, required) - ride: `100` (string, required) - inviter (UserLink) - origin (AddressLink, nullable, optional) - Inviter origin. - destination (AddressLink, nullable, optional) - Inviter destination.
49. MSON MSON: Markdown Syntax Object Notation ## Invitation Full (object) - id: `100` (string, required) - code: `cheeky-monkey352` (string, required) - links (object, required) - ride: `100` (string, required) - inviter (UserLink) - origin (AddressLink, nullable, optional) - Inviter origin. - destination (AddressLink, nullable, optional) - Inviter destination.
50. MSON ## Invitation Full (object) - id: `100` (string, required) - code: `cheeky-monkey352` (string, required) - links (object, required) - ride: `100` (string, required) - inviter (UserLink) - origin (AddressLink, nullable, optional) - Inviter origin. - destination (AddressLink, nullable, optional) - Inviter destination. MSON: Markdown Syntax Object Notation
51. ¿Y EL PROTOTIPO?
52. APIARY
53. ¿Y EL PROTOTIPO?
54. APIARY HTTP://PRIVATE-83552-MYAPI.APIARY-MOCK.COM
55. ESA M*ERDA SIEMPRE RETORNA LO MISMO! Ernestico, iOS developer
56. MOCKS
57. YA LA DOCUMENTACIÓN PUEDE QUEDAR DESACTUALIZADA
59. DREDD Datos específicos para las pruebas de Dredd
60. # ./bin/run_dredd #!/bin/sh set -e # Setup # Crear una base de datos nueva (con todas las migraciones) RAILS_ENV=test bundle exec rake db:reset # Agregar los datos específicos para Dredd RAILS_ENV=test bundle exec rake db:seed:dredd # Iniciar un servidor en background RAILS_ENV=test bundle exec rails server -b 0.0.0.0 -p 3001 & PID=$! # Guardo el número del proceso del servidor sleep 5 # Espero a que el servidor termine # Corro dredd contra el servidor y comparo contra la documentación dredd apiary.apib http://0.0.0.0:3001/ --sorted # Cleanup RESULT=$? # guardo el resultado de Dredd kill -9 $PID # mato el servidor exit $RESULT # Retorno el resultado de Dredd
61. # ./bin/run_dredd #!/bin/sh set -e # Setup # Crear una base de datos nueva (con todas las migraciones) RAILS_ENV=test bundle exec rake db:reset # Agregar los datos específicos para Dredd RAILS_ENV=test bundle exec rake db:seed:dredd # Iniciar un servidor en background RAILS_ENV=test bundle exec rails server -b 0.0.0.0 -p 3001 & PID=$! # Guardo el número del proceso del servidor sleep 5 # Espero a que el servidor termine # Corro dredd contra el servidor y comparo contra la documentación dredd apiary.apib http://0.0.0.0:3001/ --sorted # Cleanup RESULT=$? # guardo el resultado de Dredd kill -9 $PID # mato el servidor exit $RESULT # Retorno el resultado de Dredd
62. # ./bin/run_dredd #!/bin/sh set -e # Setup # Crear una base de datos nueva (con todas las migraciones) RAILS_ENV=test bundle exec rake db:reset # Agregar los datos específicos para Dredd RAILS_ENV=test bundle exec rake db:seed:dredd # Iniciar un servidor en background RAILS_ENV=test bundle exec rails server -b 0.0.0.0 -p 3001 & PID=$! # Guardo el número del proceso del servidor sleep 5 # Espero a que el servidor termine # Corro dredd contra el servidor y comparo contra la documentación dredd apiary.apib http://0.0.0.0:3001/ --sorted # Cleanup RESULT=$? # guardo el resultado de Dredd kill -9 $PID # mato el servidor exit $RESULT # Retorno el resultado de Dredd
63. # ./bin/run_dredd #!/bin/sh set -e # Setup # Crear una base de datos nueva (con todas las migraciones) RAILS_ENV=test bundle exec rake db:reset # Agregar los datos específicos para Dredd RAILS_ENV=test bundle exec rake db:seed:dredd # Iniciar un servidor en background RAILS_ENV=test bundle exec rails server -b 0.0.0.0 -p 3001 & PID=$! # Guardo el número del proceso del servidor sleep 5 # Espero a que el servidor termine # Corro dredd contra el servidor y comparo contra la documentación dredd apiary.apib http://0.0.0.0:3001/ --sorted # Cleanup RESULT=$? # guardo el resultado de Dredd kill -9 $PID # mato el servidor exit $RESULT # Retorno el resultado de Dredd
64. # ./bin/run_dredd #!/bin/sh set -e # Setup # Crear una base de datos nueva (con todas las migraciones) RAILS_ENV=test bundle exec rake db:reset # Agregar los datos específicos para Dredd RAILS_ENV=test bundle exec rake db:seed:dredd # Iniciar un servidor en background RAILS_ENV=test bundle exec rails server -b 0.0.0.0 -p 3001 & PID=$! # Guardo el número del proceso del servidor sleep 5 # Espero a que el servidor termine # Corro dredd contra el servidor y comparo contra la documentación dredd apiary.apib http://0.0.0.0:3001/ --sorted # Cleanup RESULT=$? # guardo el resultado de Dredd kill -9 $PID # mato el servidor exit $RESULT # Retorno el resultado de Dredd
65. # ./bin/run_dredd #!/bin/sh set -e # Setup # Crear una base de datos nueva (con todas las migraciones) RAILS_ENV=test bundle exec rake db:reset # Agregar los datos específicos para Dredd RAILS_ENV=test bundle exec rake db:seed:dredd # Iniciar un servidor en background RAILS_ENV=test bundle exec rails server -b 0.0.0.0 -p 3001 & PID=$! # Guardo el número del proceso del servidor sleep 5 # Espero a que el servidor termine # Corro dredd contra el servidor y comparo contra la documentación dredd apiary.apib http://0.0.0.0:3001/ --sorted # Cleanup RESULT=$? # guardo el resultado de Dredd kill -9 $PID # mato el servidor exit $RESULT # Retorno el resultado de Dredd
66. # ./bin/run_dredd #!/bin/sh set -e # Setup # Crear una base de datos nueva (con todas las migraciones) RAILS_ENV=test bundle exec rake db:reset # Agregar los datos específicos para Dredd RAILS_ENV=test bundle exec rake db:seed:dredd # Iniciar un servidor en background RAILS_ENV=test bundle exec rails server -b 0.0.0.0 -p 3001 & PID=$! # Guardo el número del proceso del servidor sleep 5 # Espero a que el servidor termine # Corro dredd contra el servidor y comparo contra la documentación dredd apiary.apib http://0.0.0.0:3001/ --sorted # Cleanup RESULT=$? # guardo el resultado de Dredd kill -9 $PID # mato el servidor exit $RESULT # Retorno el resultado de Dredd
67. FLUJO DE PROTOTIPO
68. FLUJO DE PROTOTIPO ▸ Borradores de contratos (discusión)
69. FLUJO DE PROTOTIPO ▸ Borradores de contratos (discusión) ▸ Escribir documentación (API Blueprint)
70. FLUJO DE PROTOTIPO ▸ Borradores de contratos (discusión) ▸ Escribir documentación (API Blueprint) ▸ Escribir un mock en el código
71. FLUJO DE PROTOTIPO ▸ Borradores de contratos (discusión) ▸ Escribir documentación (API Blueprint) ▸ Escribir un mock en el código ▸ Clientes empiezan a consumir API
72. FLUJO DE PROTOTIPO ▸ Borradores de contratos (discusión) ▸ Escribir documentación (API Blueprint) ▸ Escribir un mock en el código ▸ Clientes empiezan a consumir API ▸ Dredd
73. FLUJO DE PROTOTIPO ▸ Borradores de contratos (discusión) ▸ Escribir documentación (API Blueprint) ▸ Escribir un mock en el código ▸ Clientes empiezan a consumir API ▸ Dredd ▸ Hacer la implementación real
75. CICLOS DE UNA API
76. DESARROLLO DESPLIEGUE CONSUMO ANÁLISIS CLÁSICO
77. DESARROLLO DESPLIEGUE CONSUMO ANÁLISIS DISEÑO DISEÑO A-PRIORI
78. DISEÑO & PROTOTIPO DESARROLLO DESPLIEGUE ANÁLISIS CONSUMO POR PROTOTIPOS
79. REFERENCIAS (Y GRACIAS!) • How to build an API https://apiary.io/how-to-build-api • API Flow https://speakerdeck.com/zdne/api-flow • Future of Programming https://vimeo.com/71278954 • Quickly Prototype APIs with Apiary https://sendgrid.com/blog/ quickly-prototype-apis-apiary/
80. GRACIAS