1. Creando un Web API desde la idea
hasta el despliegue de forma ágil
JConf Dominicana 2021
31 de Julio del 2021. Edición Virtual.
#jconfdominicana2021
Eudris Cabrera
@EudrisCabrera

2. Eudris Cabrera
Graduado de Ingeniería Telemática en la PUCMM.
Entusiasta de la tecnología y el software libre,
desarrollador Java, instructor ocasional (Java/Linux),
aficionado del béisbol/sóftbol y los bailes latinos.
En el tiempo libre, escribe artículos, realiza charlas,
participa en eventos tecnológicos y ayuda en la
revisión de documentación técnica en el mundo Java y
el código abierto.

3. Twitter:
@JavaDominicano linktr.ee/JConfDominicana

4. AGENDA
● Antecedentes
● Desarrollo de API: Design First or Code First
● Caso de Uso Batflip Inc
● Tecnologías y herramientas a utilizar
● Etapas del desarrollo del API

5. Antecedentes
El manejo y administración de API se están generalizando, actualmente es más fácil exponer las APIs de
forma segura al mundo.
Sin embargo, el ciclo de desarrollo de API tiene algunos casos pendientes que resolver.
● Pensar en una nueva forma de entregar API
● Simplificar y acelarar el envío de API listas para producción.

6. Desarrollo de API:
Design First or Code First

7. Desarrollo de API: Design First or Code First
Code First es un enfoque más tradicional para la creación de API, y el desarrollo del código ocurre
después de que se establecen los requisitos comerciales, lo que finalmente genera la documentación a
partir del código.
Design First aboga por diseñar el contrato de la API primero antes de escribir cualquier código.

8. Desarrollo de API: Design First or Code First

9. Desarrollo de API: Design First
● Cuando la experiencia del desarrollador que implementa el API importante.
Una API bien diseñada puede hacer maravillas para la adopción y el consumo de sus API, y un buen diseño
se puede lograr mejor con el enfoque Design First.
Si su estrategia de API implica una alta adopción de su API y la retención de usuarios que se integran con
su API, entonces una buena experiencia de desarrollador (DX) es importante.

10. Desarrollo de API: Design First
● Si tu API es de misión crítica
La principal razón para optar por el enfoque Design First es cuando el público objetivo de su API son
clientes o socios externos.
En tal caso, su API es un canal de distribución clave que sus clientes finales pueden utilizar para consumir
los servicios que brinda, y un buen diseño juega un papel clave en la determinación de la satisfacción del
cliente.

11. Desarrollo de API: Design First
● Cuando quieres garantizar una buena comunicación
El contrato de API puede actuar como el borrador central que mantiene a todos los miembros de su
equipo alineados con los objetivos de su API y cómo se exponen los recursos de su API.
La identificación de errores y problemas en la arquitectura de la API con su equipo se vuelve más fácil al
inspeccionar un diseño legible por humanos.

12. Desarrollo de API: Code First
● Cuando hay urgencia con la entrega del API
Los desarrolladores pueden comenzar a implementar la API mucho más rápido si comienzan a codificar la
API directamente desde el documento de requisitos.
Esto es importante si su estrategia de comercialización enfatiza la velocidad y la agilidad como factores
importantes para el éxito del API.

13. Desarrollo de API: Code First
● Al desarrollar API internas
El enfoque Code First ofrece velocidad, automatización y complejidad de proceso reducida, a costa de
una buena experiencia de desarrollador. Si la API solo será consumida por el equipo o la empresa que la
está construyendo, entonces el enfoque Code First es una solución ideal.
Esto es especialmente cierto si la API desarrollada es pequeña con solo unos pocos puntos finales, que
solo se usarán internamente.

14. Caso de Uso Batflip Inc

15. Caso de Uso Batflip Inc
Batflip Inc produce, vende y distribuye
artículos deportivos a sus queridos clientes, y
todo el proceso se gestiona internamente.

16. La creciente competencia y la creciente demanda de los clientes están obligando a
Batflip Inc a repensar su modelo de distribución.
Es decir, la distribución se dejará a revendedores independientes que podrían vender
artículos deportivos localmente, en línea o en el sitio.
El principal desafío es cómo abrir el sistema de información para que los
revendedores independientes puedan descubrir el catálogo de artículos deportivos,
verificar el inventario, etc.

17. Nuestra experiencia nos dice que esto se puede
hacer a través de la exposición de una API.

18. Tecnologías y herramientas a utilizar
● Herramienta para diseño de API (Apicurio Studio)
● Herramienta para pruebas y simulación (Microcks)
● Herramienta para pruebas y edición de API ((Postman)
● Desarrollo del servicio (microprofile)
● Plataforma para el despligue utilizando CI-CD (Kubernetes/OpenShift)

19. Tecnologías y herramientas a utilizar

20. Etapas del desarrollo del API
● Fase 0: Evaluando ideas para el API
● Fase 1: Diseñar el contrato de la API primero antes de escribir cualquier código
● Fase 2: Hacer peticiones para validar que el resultado es el esperado
● Fase 3: Crear pruebas automátizadas de las simulaciones
● Fase 4: Desarrollo, Despliegue y prueba

21. Presentación y Demo
Vídeo:
https://youtu.be/GrQ62z-SA0M
Github:
https://github.com/ecabrerar/api-lifecycle-conference

22. Asuntos Legales
Todas las marcas registradas, así como todos los logotipos, imágenes,
fotografías, audio y vídeos mostrados en esta presentación son propiedad
de sus respectivos propietarios y/o representantes.
Su utilización es solamente para fines ilustrativos.

23. Enlaces:
https://swagger.io/blog/api-design/design-first-or-code-first-api-development/
https://blog.restcase.com/api-development-with-design-first-approach/
http://www.apicur.io/
http://microcks.github.io/
https://www.getpostman.com/
https://www.openshift.com/
https://microprofile.io/
Referencias

24. @eudriscabrera
@eudris
@ecabrerar
@eudriscabrera
Eudris Cabrera Rodríguez
Ingeniero Telemático
Desarrollador de Software / Consultor Informático
eudris@gmail.com
https://www.linkedin.com/in/eudriscabrera
http://www.slideshare.net/eudris
https://twitter.com/eudriscabrera
https://github.com/ecabrerar