determined - Fotolia

Gestionar Aprenda a aplicar las mejores prácticas y optimizar sus operaciones.

Cuatro componentes de gestión de API que debe tener

Las API no se administran solas. Conozca estos componentes clave de administración de API para asegurarse de que sus aplicaciones funcionen según lo previsto.

No es ningún secreto que las organizaciones deben tratar sus API como el elemento vital de su negocio. Parte de esto implica la creación de una estrategia de gestión de API completa e infalible.

Las empresas necesitan una herramienta que realice un seguimiento de todas las solicitudes y respuestas, supervise el rendimiento, proporcione una rápida corrección de errores y garantice que cualquier desarrollador consumidor pueda poner en funcionamiento fácilmente su API.

En esta función, analizaremos los cuatro componentes de administración de API imprescindibles y exploraremos las prácticas y herramientas necesarias para abordar cada uno.

1. Entorno de prueba de API

Un entorno de prueba adecuado es un componente esencial de cualquier estrategia de gestión de API. Idealmente, esto debería existir como una versión localizada del entorno de producción de la API.

Hay tres tipos principales de pruebas de API para priorizar:

  • Las pruebas funcionales validan que todas las características y funciones de la API funcionan según lo previsto. Las pruebas funcionales también deben apuntar a la seguridad y los mecanismos de manejo de errores que protegen la API.
  • Las pruebas de rendimiento evalúan qué tan bien una API maneja las cargas de trabajo necesarias, en particular en momentos de uso intensivo. Simule tráfico errático y condiciones de carga impredecibles para investigar los puntos débiles de rendimiento.
  • Las pruebas de aceptación miden si una API cumple adecuadamente su propósito previsto. Estas pruebas pueden revelar si los cambios en la API afectan su uso previsto e identificar posibles cambios que podrían hacer que la API sea más útil.

2. Puerta de enlace API

Una puerta de enlace API se encuentra en el centro de la comunicación de API. De manera similar a un bus de servicio empresarial, la puerta de enlace (gateway) actúa como un administrador de mensajería que intercepta una llamada a la API, la transfiere a la API adecuada y luego maneja la respuesta. En lugar de administrar una red compleja de integraciones de API una por una, este componente de administración de API proporciona un punto de contacto abstraído, pero centralizado, para llamadas y respuestas.

Un diagrama del patrón básico de puerta de enlace API.

En los casos en que las API se integran con sistemas externos que hablan un idioma diferente, la puerta de enlace API actúa como traductor. Por ejemplo, las puertas de enlace suelen ser capaces de convertir formatos de protocolo basados ​​en web en aquellos que las API basadas en SOAP pueden comprender, como XML. Muchos productos de puerta de enlace también incluyen herramientas de seguimiento y monitoreo automatizadas que rastrean el movimiento de las API a través de ellos y registran todas las transacciones de llamadas/respuestas.

3. Documentación de API

Una buena documentación es un componente integral de la gestión de API y posiblemente sea tan importante como el código subyacente. La falta de documentación adecuada ralentizará el proceso de desarrollo y dañará la funcionalidad de su API, además de impedir los esfuerzos de adopción y modificación. Sin una buena documentación, adoptar o modificar la API es un proceso frustrante y que requiere mucho tiempo. Además, la documentación garantiza que el código permanezca intacto y realiza un seguimiento de los cambios entre desarrolladores.

Hay tres categorías amplias de documentación de API:

  • La documentación de referencia cubre los detalles granulares de una API, incluida una sintaxis completa de cada llamada y solicitud que admite.
  • La documentación de ejemplo ilustra los casos de uso de las API. Por ejemplo, si una API en particular puede leer formatos métricos e imperiales de datos de medición, la documentación de ejemplo debe incluir líneas de código que muestren cómo la API maneja los diferentes formatos.
  • La documentación del tutorial proporciona contexto para la API. Normalmente, se trata de guías y tutoriales sobre el uso de la API.

4. Portal para desarrolladores de API

El portal para desarrolladores actúa como un escaparate entre las API y los desarrolladores. Un portal de desarrollador adecuado debe proporcionar guías legibles por humanos que describan lo que hace la API, tutoriales con instrucciones de uso paso a paso y SDK que ayuden a los desarrolladores a integrarse con las API.

El portal debe incluir un mecanismo de catálogo de API que sea de fácil acceso y navegación. Esto debe incluir ejemplos de posibles respuestas de API que ayuden a los desarrolladores a comprender el comportamiento y lo que pueden crear con ellos. Un portal también debe proporcionar la información contenida en la documentación de su API, incluidas referencias para rutas, solicitudes y respuestas HTTP. Finalmente, proporcione registros de cambios que registren actualizaciones y errores, así como un rastreador en tiempo real que muestre el estado actual de una API en particular.

Investigue más sobre Desarrollo de aplicaciones

Inicie la conversación

Envíenme notificaciones cuando otros miembros comenten sobre este artículo.

Por favor cree un Nombre de usuario para poder comentar.

Close