Header Ads Widget

Ticker

6/recent/ticker-posts

Introducción a los principios para impulsar la economía de las API


 La gente desarrolla API por todo tipo de razones. Puede que estén intentando crear una herramienta para facilitar los procesos internos donde trabajan, podrían estar creando un producto externo para los clientes o podrían estar creando una herramienta de terceros diseñada para combinar otros servicios. Y eso es solo una parte de la superficie de por qué alguien podría buscar construir una API, con algunos productos que abarcan partes o todo lo anterior y más.

Por eso es difícil crear un plan repetible para el desarrollo de API y el negocio que sea específico en términos de flujo de trabajo y resultados; lo que es adecuado para una empresa no necesariamente lo será para otra. Sin embargo, eso no significa que no valga la pena tratar de identificar las mejores prácticas relacionadas con la producción y el mantenimiento de las API.

Así como existen guías de estilo para el desarrollo de API web (consulte el Libro de estilo de API de API Handyman ), en este artículo buscaremos determinar si existen guías igualmente repetibles para la participación en la economía de API y el desarrollo empresarial .

Un manifiesto para la práctica de API

Manifiesto API: "Principios que impulsan la economía API"

Reunir un grupo de principios es exactamente lo que ha estado haciendo un grupo de desarrolladores finlandeses durante los últimos años. El grupo supervisa un documento de trabajo llamado The API Manifesto ; una doctrina de 7 principios que impulsan la economía. No pudimos evitar notar que, cuando se toma en su conjunto, el documento se parece muchísimo a un plano , aunque no técnico, para crear una API exitosa.

Presentado por primera vez en 2015, Jarkko Moilanen abrió un debate sobre la economía API en Finlandia. El objetivo era encontrar de 5 a 10 tesis o medidas que ayudarían a fomentar la producción de API en el país.

El grupo de trabajo está compuesto por 18 colaboradores, incluidos todos, desde especialistas en TI hasta personas que trabajan (ed) en la Federación de Industrias Tecnológicas de Finlandia y en el Ministerio de Finanzas. En otras palabras, una serie de mentes brillantes con opiniones firmes sobre la dirección actual y futura del espacio API.

A continuación, veremos cada punto del manifiesto y consideraremos cómo se aplica a la producción de API en un sentido más amplio.

Sirve con interfaz digital (API)

Este es evidente para nuestros lectores, pero quizás aún no sea evidente para algunos profesionales de TI. Esta declaración recibe un énfasis particular dentro del Manifiesto API:

"Las interfaces funcionales son la condición previa para la creación y escalado de ecosistemas digitales".

Es una declaración audaz, sin duda, pero una que probablemente suene a verdad para muchos de nuestros lectores. No somos tímidos cuando se trata de escribir sobre cómo la adopción de API es fundamental para la ventaja actual del mercado , así como para la escalabilidad futura . Una mentalidad de API primero es el núcleo del desarrollo de arquitecturas de microservicios y la creación de backends ágiles para plataformas digitales.

Prefiero la transparencia

Cuando algunos desarrolladores crean algo emocionante, su primer instinto es esconderlo hasta que puedan asegurarse de que tenga la marca de ellos. Afortunadamente, desde el nacimiento del movimiento de código abierto y el crecimiento explosivo de los sitios de intercambio de conocimientos como Stack Overflow , las interfaces abiertas y las API públicas son cada vez más comunes.

Por ejemplo, cuando se trata de ofrecer una API pública y convertir a los visitantes del sitio en clientes, se recomiendan registros transparentes de estado y tiempo de actividad. Y eso es por una buena razón; El Manifiesto API destaca el hecho de que " se ha demostrado que la transparencia produce una mejor calidad más rápido ". Por supuesto, hay ocasiones en las que deberá tomar ciertas medidas para proteger su IP. Pero, para la mayoría de los desarrolladores de API, la transparencia es crucial para generar un interés sostenido en un programa público de API.

Lea también: Datos abiertos: ¿cómo hacer que funcione para su negocio?

Haga que la incorporación sea lo más fácil posible

En caso de que aún no haya recibido el mensaje de este blog, la documentación sólida es extremadamente importante. Un portal para desarrolladores acogedor que está repleto de información útil no es solo "agradable de tener", es esencial para una API potente.

El API Manifesto lo resume bastante bien cuando dice "La buena documentación también es rica en estudios de casos y ejemplos de código ". ¡No podemos decirlo mucho más claro que eso!

En esa nota, consulte: Elaboración de excelentes tutoriales de código API que reducen el tiempo de incorporación

Mide, recibe comentarios e itera

Para demasiados desarrolladores, poner una API en vivo es el paso final del proyecto. El resto de nosotros sabemos que una versión v1 es solo el primer paso de un proceso continuo . Monitorear los puntos finales de API de alto tráfico puede ayudarlo no solo a determinar si la API es un éxito o no, sino que también ofrece información valiosa sobre las áreas en las que debe enfocarse a continuación.

El tema del control de versiones puede ser divisivo, pero se recomienda tener un enfoque para el cambio iterativo en el Manifiesto API: “La retroalimentación permite la iteración, lo que significa el desarrollo continuo de la interfaz con los pasos más pequeños y fáciles de manejar. Implemente el control de versiones de la interfaz si es necesario ".

Vale la pena recordar que el manifiesto está diseñado para ofrecer orientación, en lugar de dejar las cosas en piedra. Si retira o no las API y las reemplaza con nuevas versiones o, como sugiere Roy Fielding, no versiona su API en absoluto, probablemente dependerá del tamaño y la frecuencia de los cambios que planea realizar.

Colabora con otros

La mayoría de las API tienen la colaboración en su núcleo. Ya sea que eso signifique trabajar con los usuarios desarrolladores para establecer lo que necesitan de una API o trabajar con socios para asegurarse de que sus API sean compatibles entre sí, siempre es más fácil hacer y responder preguntas que tener que probar todo manualmente.

Por supuesto, no siempre es posible trabajar así. Si está intentando conectar su API a los datos de Google, por ejemplo, es bastante poco probable que pueda hablar con alguien de la empresa. Aún así, es aconsejable mantener la colaboración en el centro de lo que hace tanto como sea posible: “Los ecosistemas vibrantes y diversos se construyen alrededor de excelentes interfaces. "

Implementar consistentemente

Cuando los espectadores consideran el uso de la API, pueden desactivarse fácilmente por las páginas de estado que no se han actualizado recientemente o por un estilo de API inconsistente.

Cuando se trata del meollo de la cuestión técnica, es posible que no siempre sea posible estandarizar y mantener un cronograma constante. El API Manifesto nos recuerda el hecho de que "las especificaciones de requisitos extensas de cientos de páginas generalmente ya están desactualizadas cuando se completan ". Por lo tanto, la actualización incremental y continua es sin duda un enfoque más ágil para mantener la coherencia.

Pero eso no significa que no pueda estandarizar la forma en que se describen las API; "Independientemente de quién los implemente o de la tecnología que se utilice ... Use los mismos patrones de diseño, pero también deje espacio para maniobrar y ajustar".

Construir para un propósito

Este puede ser el último punto del Manifiesto de API, pero podría decirse que es el punto más importante al que debe adherirse cualquier productor de API. " Constrúyalo y ellos vendrán " no es una estrategia de marketing API válida, pero también "constrúyalo y ellos se quedará ”tampoco lo es.

Una API debe tener atención continua además de un propósito útil en su núcleo. Esta propuesta de valor podría equivaler a ahorrar tiempo al usuario, realizar funciones novedosas o generar experiencias interesantes para el usuario. Sin eso, carecerá de la adherencia que todos los buenos productos necesitan para retener y hacer crecer una base de usuarios.

Pensamientos finales

Es posible que el API Manifesto no incluya muchos de los aspectos técnicos de la creación de una API, como comparar REST vs SOAP vs GraphQL vs RPC, o si cotizar en bolsa o vender acceso, etc., pero aún es una lectura interesante para cualquiera que esté mirando mejorando el espacio API.

Lo que quizás sea más interesante acerca del Manifiesto API es, a pesar de la amplia gama de personas del sector público y privado que lo respaldan, cuán consistentes y congruentes son cada uno de los puntos que se presentan en él.

Puede que nunca haya una solución milagrosa para saber exactamente cómo crear la API perfecta , pero cualquiera que intente familiarizarse con los principios básicos detrás de la mayoría de los tipos de desarrollo de API podría hacerlo mucho peor que comenzar con un documento como The API Manifesto.

Vea una traducción del finlandés al inglés del Manifiesto API y descubra más sobre sus colaboradores aquí .

Publicar un comentario

0 Comentarios