Manual del mezclador del ciclo de vida de API: ¿Qué se incluye en una única fuente de verdad?

Por: Ariel DiFelice el 9 de junio de 2023

En coctelería, el manual del mezclador es una fuente de información confiable. Estos libros pueden contener cientos de recetas de cócteles clásicos, algunos de los cuales pueden tener 100 años, mientras que otros pueden ser bebidas que recién aparecieron en escena. Los manuales de Mixer también pueden ser excelentes fuentes de inspiración para recetas nuevas, aún por probar, para adiciones emocionantes a las ofertas de un bar o restaurante. Este acto de equilibrio de preservar lo antiguo y fomentar la exploración de lo nuevo puede proporcionar una lección valiosa para el desarrollo de API en el mundo del software. La "única fuente de verdad" de una API es, en muchos sentidos, el propio manual del mezclador de la organización de software. Esto es especialmente cierto cuando se adopta el enfoque correcto para garantizar que el software siga siendo funcional y de alto rendimiento y ofrezca experiencias que deleiten a los clientes y los hagan volver por más.

Si bien podemos pensar en la mixología y los mixólogos que practican este oficio como términos relativamente nuevos, el primer uso registrado de la palabra "mixólogo" se remonta a 1852 y "mixología" siguió poco después.

¿Qué tan similares son el trabajo, la mentalidad y las pasiones de los mixólogos y los desarrolladores y diseñadores de API? Mira esta definición de mixólogo y cuenta las similitudes por ti mismo:

"El término 'mixólogo' se refiere a alguien que estudia la historia de las bebidas mezcladas, tiene una gran apreciación de los ingredientes y las técnicas utilizadas y crea regularmente bebidas mezcladas nuevas e innovadoras... el título de su trabajo implica que hace una parte importante de su trabajo detrás las escenas, creando nuevos cócteles artesanales y dando su toque característico a los favoritos existentes".

Los mejores desarrolladores, diseñadores y arquitectos de API del mundo deberían reconocer mucho de lo anterior en su propio trabajo. Tienen un profundo respeto por su oficio y siempre lo están perfeccionando. Buscan entender los gustos y paladares de sus consumidores. Tienen en cuenta los aportes de otras partes interesadas, prueban, iteran y prueban sus creaciones nuevamente antes de "servir" esas API a producción.

Al igual que los mixólogos y los cantineros (si los ve como dos roles diferentes), cada profesional a lo largo del ciclo de vida de la API debe comprender las necesidades de los consumidores, los clientes y el negocio, y luego diseñar y desarrollar sus API en consecuencia. Una parte esencial de este proceso es la validación continua y la adaptación a los requisitos del mercado.

Los cambios en las API, incluso los menores, pueden tener efectos posteriores significativos. Y lo mismo puede decirse de los ajustes realizados a una receta de cóctel antigua, donde agregar o quitar una sola pizca de esto o aquello puede cambiar por completo el sabor de una bebida... así como el interés de las personas en ella.

Si bien no hay una tasa de cambio "estándar" en las API para planificar, puede esperar que se necesiten cambios con cada nueva versión de software. Esto podría significar que se están realizando cambios (y deben probarse y validarse) cada pocas semanas, cada mes o incluso todos los días, según la cadencia de lanzamiento. También puede haber cambios ad-hoc según sea necesario.

Lo que es crucial para que los equipos se aseguren es que estos cambios no interrumpan la funcionalidad o el rendimiento de una API. Para que esto sea posible, los equipos aprovechan cada vez más las pruebas de contrato de API para proporcionar una especie de red de seguridad. Esto viene en forma de prueba que valida los cambios contra un "contrato" que detalla la funcionalidad original, acordada y, por lo tanto, requerida de una API.

La capacidad de prever los impactos de los cambios en las API puede depender de la madurez de un equipo de ingeniería y su capacidad para colaborar entre departamentos, zonas horarias y diferentes niveles de experiencia técnica. Las herramientas y pautas que promueven la estandarización y la colaboración pueden evitar que los contratiempos pasen por alto o se cieguen a los efectos negativos posteriores.

Ya sea que estemos hablando de poder confiar en una única fuente de verdad para la versión más actualizada de una API publicada o la última edición del manual de un mezclador para recetas de bebidas probadas y verdaderas, la documentación clara y concisa es llave. Pero tampoco es suficiente que esta documentación simplemente exista.

Parece de sentido común, aunque probablemente haya trabajado en algún lugar donde no lo era, que la documentación de su API también debe ser fácilmente accesible, comprensible y utilizable. Garantizar todas estas cosas conduce a una incorporación más fluida y una experiencia de desarrollador positiva y, en última instancia, a una adopción más amplia de una API funcional y de alto rendimiento que cumple o incluso supera las expectativas.

La documentación de la API suele ser el primer punto de contacto que un desarrollador tiene con una API. Sirve como guía, guiando a los desarrolladores a través de las funciones, los puntos finales, los modelos de solicitud/respuesta y los mensajes de error de la API. También proporciona información sobre la lógica empresarial subyacente y las características únicas de una API.

Una buena documentación de API sigue el principio de una única fuente de verdad, lo que significa que debe ser completa, actualizada y coherente. Siempre debe reflejar el comportamiento real de la API, lo que reduce las conjeturas para los desarrolladores y minimiza la posibilidad de malentendidos y errores.

Así como un coctelero confía en una receta de cóctel detallada y precisa para brindar una experiencia agradable a un cliente, los desarrolladores de API dependen de una buena documentación para crear y entregar API útiles y de valor agregado y aplicaciones poderosas.

Al igual que un mixólogo que ajusta meticulosamente los ingredientes de un cóctel o que crea nuevos cócteles para satisfacer los gustos cambiantes de los clientes, los desarrolladores deben adaptar constantemente sus API para satisfacer las cambiantes demandas del mercado, las necesidades comerciales y los estándares de la industria.

Esto se logra a través de una potente combinación de investigación de mercado, colaboración, cumplimiento de estándares y control y pruebas meticulosas. Sin embargo, a medida que las tecnologías y los procesos de desarrollo, prueba e implementación de software continúan evolucionando, la industria tecnológica debe continuar educándose y refinando sus prácticas.

Con una mentalidad enfocada en el aprendizaje constante y la mejora continua y una fuente única confiable de verdad como guía, los equipos de desarrollo pueden brindar con confianza experiencias API excepcionales en cada versión. Al final, el objetivo es crear API que sean confiables y fáciles de consumir y que satisfagan las necesidades únicas del momento, como la bebida perfecta de un mixólogo.

Archivado como: API, gestión/supervisión del rendimiento de aplicaciones, blogs, cultura de DevOps, práctica de DevOps, Doin' DevOps Etiquetado con: API, API, CI/CD, desarrolladores, desarrollo, documentación, SDLC. ciclo de vida, software, pruebas