Header Ads Widget

Ticker

6/recent/ticker-posts

Etapa de desarrollo del ciclo de vida de la API: implementación de su API

lifecycle_development_series

Ciclo de vida de la API

El ciclo de vida de la API es un proceso ágil para administrar la vida de una API. El ciclo de vida de la API común se compone de cuatro fases distintas: análisis, desarrollo, operaciones y retiro.

Durante el transcurso de este artículo, llegará a comprender las acciones a tomar, así como los desafíos más importantes a abordar durante la fase de desarrollo de una API Consideraremos qué opciones de implementación están disponibles y exploraremos API Management y por qué es importante. Definiremos la usabilidad de la API y por qué es importante , y consideraremos qué pasos inmediatos tomar después de implementar su API.

La acción más importante en esta fase del ciclo de vida de la API es implementar la API y darle vida. Siga leyendo para obtener más información sobre este proceso y comprender qué factores contribuyen a elegir la mejor combinación de estándares y lenguajes de programación para su API.

Cosas a considerar durante la implementación

En este punto, debe tener una estrategia comercial y una documentación API bien definida . Esto incluye definir quiénes serán las principales partes interesadas de la API y decidir cómo se consumirá la API. En este punto, debería tener respuestas a las siguientes preguntas:

  • Que valor aporta la API? ¿Es un medio para distribuir datos o ofrece una funcionalidad específica que se puede utilizar para crear aplicaciones?
  • Quien consumirá la API? ¿Los consumidores interactúan con su API para obtener acceso a los datos o los consumen en nombre de otros usuarios?
  • ¿Cuántos consumidores tendrá la API? ¿Es una API privada consumida internamente o estará disponible para millones de consumidores potenciales?

Responder estas preguntas le ayudará a tomar atajos durante el proceso de implementación. Comencemos por comprender qué está tratando de habilitar con su API para que pueda definir qué métodos y protocolos va a utilizar.

Banner básico-01

Métodos y protocolos

La mejor manera de definir métodos y puntos finales para su API es seguir la funcionalidad que le gustaría proporcionar y elegir los estándares y protocolos más apropiados. Identifique qué tipo de manipulación de datos suelen tener disponibles sus principales consumidores de API.

Si sus principales consumidores son las aplicaciones móviles, considere ofrecer terminales que soliciten y respondan con la menor cantidad de información posible. Esto es para evitar un gran consumo de ancho de banda y acelerar las operaciones que involucran llamadas a su API. Si, por el contrario, está ofreciendo una API que será consumida principalmente por el mercado financiero, estudie cuidadosamente qué marcos están usando y cómo se comunican con las API externas.

Hagas lo que hagas, te recomendamos que no sigas las últimas tendencias presentadas como "el futuro". Las tendencias pueden cambiar y cambiarán muchas veces antes de que se estabilicen y se adopten ampliamente, y su API tendrá que mantenerse al día con esta fluctuación del mercado. Determine qué está utilizando el 80% de su público objetivo y ofrézcalo.

Leer más: Cómo hacer que su API sea ágil

Lenguajes de programación SDK

Elegir cómo ofrecerá acceso a su API está directamente relacionado con cómo se consumirá su API. ¿Lo consumirán principalmente los desarrolladores de aplicaciones móviles? Luego, ofrezca SDK móviles listos para usar. La lluvia de ideas sobre los posibles casos de uso de API es el primer paso para elegir cómo se empaquetará su SDK.

Si no está 100% seguro de cómo se utilizará su API, siempre puede ofrecer un SDK en varios lenguajes de programación populares. Algolia , una API de motor de búsqueda, está siguiendo este enfoque al ofrecer una manera fácil de usar su servicio en lenguajes como Ruby, Python, Node, PHP u Objective-C. Sin embargo, tenga en cuenta que mantener una gran cantidad de SDK no es una tarea fácil a medida que su API evoluciona y los métodos cambian. APIMATIC y REST Unidos son dos servicios que ofrecen generación automática de SDK. Con estas herramientas, cada vez que cambia su API, puede volver a ejecutar la generación de SDK para poner a disposición de sus consumidores versiones nuevas del código.

Gestión de API

Después de implementar sus puntos finales de API y decidir cómo los consumidores interactuarán con su API, debe considerar las operaciones en curso. Los factores más importantes son controlar las condiciones de acceso a la API y determinar cómo comportarse en los picos de uso. Puede seguir un enfoque de bricolaje o utilizar un servicio de administración de API como 3scale o Apigee .

Cualquiera que sea la solución que elija, recuerde que estará atado a la forma en que funciona. Defina cuidadosamente los objetivos a largo plazo, así como los escenarios comunes que desea abordar. Si elige una solución que no ofrece lo que la mayoría de los consumidores de API utilizan, es probable que se vea obligado a cambiar a largo plazo.

Recorrido por la publicación del blog CTA 5-01

Control de acceso

Uno de los aspectos más importantes de la gestión de API es definir y automatizar el proceso de controlar quién puede acceder a su API y qué medidas existen para habilitar la limitación de acceso, si es necesario.

La mayoría de las plataformas de gestión de API proporcionan algún tipo de funciones de control de acceso, incluida la clasificación de límite de llamadas de API y la diferenciación del consumidor con la ayuda de diferentes planes de pago. La primera característica de control de acceso que debe buscar es cómo su API autenticará y autorizará a los consumidores.

Hay varias opciones según el tipo de consumidores que tendrá y el tipo de uso que se producirá:

  • Claves de API : la forma más sencilla de controlar el acceso a su API. Por lo general, tendrá que emitir una clave API para cada consumidor y la identificación se proporcionará a través de un HTTPencabezado en todas y cada una de las llamadas.
  • OAuth 2 : quizás el estándar de autorización más popular utilizado por las API web. OAuth 2 le permite combinar la autenticación basada en tokens con un control de acceso detallado según los ámbitos de los usuarios. Esta es la mejor solución cuando los consumidores de API realizan llamadas en nombre de otros usuarios.
  • Dirección IP de origen : puede combinarse con otros métodos de control de acceso o usarse por sí sola. Su uso solo se realiza en los casos en que proporciona una API a una audiencia muy limitada. Para lograr mejores resultados, también debe agregar información de origen a sus registros y análisis de uso.

Cualquiera que sea la estrategia de control de acceso que elija, recuerde siempre que debe adaptarse a los casos de uso más populares de su API. Por ejemplo, no tiene sentido usar una autenticación basada en clave API simple si su uso principal de API es a través de una aplicación móvil. En este caso, tendría sentido utilizar OAuth y dejar que la aplicación móvil actúe en nombre de sus usuarios.

Más sobre el control de acceso a API: profundización en OAuth y OpenID Connect

Mantenimiento

Si bien lanzar su API puede ser un desafío emocionante, mantenerla en funcionamiento a menudo se considera algo aburrido. El mantenimiento de la API a menudo se delega a un segundo plan y solo se considera después de que las cosas comienzan a salir mal. No sigas este camino; Implementar un buen plan de mantenimiento desde el principio.

Las actividades habituales en torno al mantenimiento de su API están relacionadas con la documentación , la comunicación con los consumidores y la comprensión proactiva si algo no funciona como se esperaba. Como tal, una gran parte del mantenimiento se realiza probando periódicamente su API para asegurarse de que todo funcione según lo documentado.

Pruebas

Una forma de comprender de forma proactiva si su API se está desempeñando de acuerdo con la documentación que proporciona y siguiendo su calidad de servicio es ejecutar pruebas periódicas en puntos finales individuales. Con la supervisión implementada, si alguna de las pruebas falla, es de esperar que pueda corregir el error antes de que sus consumidores experimenten problemas. Estos tipos de pruebas se pueden realizar en su API:

  • Orientado al rendimiento : estas son pruebas que realizan llamadas individuales a todos y cada uno de los métodos que proporciona su API. Si una respuesta tarda más de un límite de tiempo especificado, significa que hay un problema en ese punto final específico.
  • Prueba funcional : este tipo de prueba funciona mediante la realización de llamadas singulares a cada método de API para probar a fondo cada función de API, utilizando diferentes tipos de cargas útiles o incluso enviando datos que producirán errores. Luego, las respuestas se comparan con el comportamiento esperado para localizar errores.
  • Prueba de casos de uso : este es un tipo de prueba más sofisticado y se puede lograr combinando llamadas a diferentes puntos finales en una sola prueba. Cada prueba debe esperar una respuesta específica y un límite de tiempo de ejecución.

Existen varias herramientas que pueden ayudarlo a ejecutar pruebas de API periódicamente de forma automatizada. POSTMAN , por ejemplo, es una aplicación de Chrome que le permite ejecutar todas las pruebas mencionadas anteriormente. Si está buscando algo más SaaSy, puede probar Runscope , un servicio que periódicamente ejecuta pruebas e informa sobre sus resultados. Otras soluciones útiles de supervisión de API incluyen APImetrics y API Science .

Gestionar cambios

Incluso si todo funciona como se esperaba, a veces deberá introducir cambios en su API. Cuando esto suceda, considere el impacto en sus consumidores y sistemas internos al:

  • Informar a los consumidores sobre los cambios : establezca un canal de comunicación claro entre usted y los desarrolladores utilizando su API para informarles de los cambios de manera transparente.
  • Mantener la compatibilidad con versiones anteriores : asegúrese de que cualquier cambio introducido no rompa lo que ya estaba funcionando. Recuerde que es posible que sus consumidores de API no puedan actualizar sus sistemas de inmediato.
  • Minimización del tiempo de inactividad : no detenga los sistemas, ni siquiera momentáneamente. Sus procesos de construcción e implementación deben garantizar que los cambios de API no afectarán las llamadas y funcionalidades de API. El tiempo de inactividad de la API puede generar tiempo de inactividad o pérdida de calidad por parte del consumidor, así que manténgalo al mínimo.

El tiempo de inactividad se puede minimizar siguiendo un enfoque de integración continua y probando su código a fondo antes de implementarlo. Asegurarse de que no haya cambios importantes se puede lograr siguiendo una sólida estrategia de control de versiones de API. Si ofrece y mantiene diferentes versiones de su API, los consumidores no sentirán los cambios en la versión que están usando. Una solución útil que cierra la brecha entre los cambios en la documentación de la API y el consumidor es API Changelog , una herramienta que descubre automáticamente los cambios en la documentación de la API e informa a los suscriptores.

Próximos pasos:

Como ya comprende, el desarrollo de una API no se limita a escribir el código y ponerlo a disposición. Comprender su caso de uso de API juega un papel importante en la construcción de la base de su oferta. Mantener la salud adecuada de la API significa nunca dejarla desatendida, ya que corre el riesgo de una disminución en la retención de consumidores y un daño a su marca.

Esta etapa del ciclo de vida de la API es tan crítica que se han lanzado numerosos servicios y se han creado muchas nuevas empresas solo para ayudar a las empresas a lidiar con todo lo que está involucrado. Estas herramientas lo ayudarán a comprender lo que debe hacer a continuación. Si está motivado para introducir cambios importantes en su API, le recomendamos que visite la Etapa de análisis para tratar esas iteraciones como un lanzamiento o una nueva versión de API. De lo contrario, salte a la etapa de operaciones y ejecute su API como un producto, fomentando su base de usuarios.

Elige tu aventura:

Avance a cualquiera de los siguientes artículos de la serie Ciclo de vida de API :

  1. Introducción: Visualización del ciclo de vida de la API
  2. Etapa de análisis: preparación de su estrategia de API
  3. Etapa de desarrollo: implementación de su API
  4. Etapa de operaciones:  comercialización de su API
  5. Etapa de retiro: una historia de los principales retiros de API públicas: la guía definitiva
Quiere más-01


 

Publicar un comentario

0 Comentarios