¿Qué es el Centro de API de Azure?
Azure API Center es un servicio nuevo de Azure que ofrece un repositorio estructurado y centralizado de todas las API de la organización, lo que permite el seguimiento unificado, la detección, la reutilización y la gobernanza. API Center es una solución segura que consolida y organiza todas las API independientemente de su tipo, fase de ciclo de vida de desarrollo o ubicación de implementación para el entorno de ejecución de la API, junto con cualquier metadato o información relacionada con la API.
Ventajas de API Center
| Problema del cliente | Ventajas de API Center |
|---|---|
| Detección y reutilización deficientes de API | Facilidad de detección y consumo de API. Los administradores de API pueden ver un inventario completo de todas las API en Azure Portal. Los consumidores de API pueden usar el portal de API Center basado en web para detectar y consumir API, o bien usar la extensión API Center para Visual Studio Code para compilar, detectar y consumir API. |
| API paralelas sin control | Inventario centralizado de las API. API Center permite a las organizaciones crear un repositorio central de API de diferentes equipos y departamentos que actúan como una fuente consolidada de verdad y confianza para todas las API. |
| Posibles amenazas de seguridad | Facilidad de gobernanza de API. Con las API consolidadas en una ubicación, la gobernanza de estas API para aplicar directivas de seguridad de la organización resulta más fácil para los equipos de la plataforma de API. |
| Diseño incoherente de API | Comprobaciones automatizadas de conformidad de diseño de las API. API Center permite a los administradores aplicar estándares de diseño en todas las API e implementa un flujo de trabajo de linting que comprueba las API con una guía de estilo definida y genera un informe de cumplimiento de API accesible desde API Center. |
Roles y responsabilidades del ecosistema de API
El ecosistema de API de una organización suele constar de diferentes roles con diversas responsabilidades que son integrales a su correcto funcionamiento. Ahora se analizará con más detalle algunos de los roles.
Productores de API: podrían ser desarrolladores individuales o equipos cuyas principales responsabilidades incluyen las siguientes:
- Consolidación de especificaciones y requisitos del sistema
- Diseño de la arquitectura de API para que se ajuste a los objetivos definidos
- Desarrollo, protección y publicación de las API
- Pruebas y garantía de que las API cumplen los requisitos funcionales y de rendimiento
- Documentación de las API
- Operaciones de mantenimiento de API, que incluyen la administración de versiones y actualizaciones
Los productores de API se esfuerzan por garantizar que siguen los procedimientos recomendados, las directivas de seguridad y cumplimiento, y los estándares de API de la organización para mantener la coherencia. También deben asegurarse de que no duplica el esfuerzo de equipos anteriores u otros de la organización.
Consumidores de API: podrían ser usuarios internos o externos de las API que:
- Consumen API privadas en sus flujos de trabajo y servicios empresariales internos (consumidores internos)
- Usan puntos de conexión de API restringidos para integrarse en asociaciones empresariales estratégicas (consumidores asociados)
- Consumen API disponibles públicamente para crear sistemas externos que usan servicios proporcionados por la organización (consumidores de terceros)
Los consumidores de API deben asegurarse de que detectan rápidamente las API más adecuadas para sus cargas de trabajo con el fin de evitar perder valiosos recursos de desarrollo y esfuerzos a causa de las duplicaciones. Para lograr esto, es importante que reciban documentación de calidad y fácil de usar para validar las API que resuelven sus necesidades concretas y que pueden integrar sin problemas en sus aplicaciones.
Equipo de la plataforma de API: los ingenieros de plataforma de API se preocupan por crear y mantener arquitecturas de API escalables, seguras y de alto rendimiento para su organización. Algunas de sus tareas pueden incluir las siguientes:
- Diseño y desarrollo de la arquitectura de API
- Establecimiento y aplicación de procedimientos recomendados de API y estándares de diseño en toda la organización
- Aplicar la supervisión, el análisis y los informes para generar información práctica
- Implementar y administrar la seguridad de API a través de protocolos de autenticación, autorización y cifrado
- Facilitar la colaboración y los comentarios entre los administradores de productos, los productores de API y los consumidores para alinearse con las estrategias de API
- Ayudar con la integración y solución de problemas de API tanto interna como externamente
Los ingenieros de plataforma de API de Contoso trabajan de manera conjunta para implementar una estrategia fácil de adoptar que impedirá que la organización experimente una expansión de la API.
Funcionamiento de API Center
Los ingenieros de plataforma de API de una organización necesitan una manera rápida y sencilla de configurar un repositorio centralizado de todas sus API (tanto internas como externas) junto con cualquier otro metadato, como versiones de API, definiciones, etc. Con API Center, puede crear un catálogo de API hospedadas y administradas en diferentes soluciones de administración de API y administrarlas en sus diferentes ciclos de vida de diseño, desarrollo, pruebas y producción.
Funcionalidades de Azure API Center
Inventario de API
En la base de API Center se crea un inventario completo y actualizado de todas las API creadas y usadas en toda la organización. Este inventario es clave para habilitar la gobernanza, la detección y el consumo de API a gran escala.
Con API Center, puede agregar API al inventario independientemente de lo siguiente:
- Tecnología y lenguaje de la API: ASP.NET Core Web API, Express, FastAPI, API sin servidor, etc.
- Tipo de API: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook, etc.
- Entorno en tiempo de ejecución: Clúster de Kubernetes, aplicación web, API Management, Apigee API Management, Azure Functions, etc.
Gobernanza de API
Ahora, con un inventario completo de API, es necesario examinar cómo asegurarse de que estas API sean coherentes, estandarizadas, utilizables y seguras. La gobernanza de API se define como el procedimiento de definir y aplicar estándares, directivas y procesos a gran escala en todas las API de la organización.
Esta funcionalidad de API Center simplifica el seguimiento de las API mediante metadatos como versiones, propietarios, ciclo de vida y seguimiento de procesos, como revisiones de cumplimiento, detección de cambios importantes, etc.
API Center también ofrece herramientas sobre la gobernanza del diseño de API que admite linting, implementada mediante el linter JSON/YAML espectral, que garantiza que las API registradas se ajusten a las reglas de estilo de la organización y proporciona una funcionalidad de análisis para las API. Habilitar esto para la organización ayuda con la detección temprana de errores e incoherencias mediante la generación de un informe de cumplimiento que se puede ver en API Center.
Los esfuerzos de la plataforma de API son más exitosos cuando los desarrolladores los admiten. La extensión API Center para Visual Studio Code proporciona funcionalidades de gobernanza de API de desplazamiento a la izquierda para interrumpir la detección de cambios y la gobernanza del diseño de API a fin de asegurarse de que las API se crean de la manera correcta la primera vez.
Detección y consumo de API
API Center simplifica todo el ciclo de vida de desarrollo de API, lo que mejora la experiencia del desarrollador mediante la integración con herramientas de desarrollo populares como Visual Studio Code. La extensión API Center proporciona una experiencia para que los consumidores de API detecten, prueben y consuman API directamente dentro de Visual Studio Code en el contexto de su funcionamiento existente. Otra funcionalidad de API Center es un portal tradicional API Center basado en web, diseñado para permitir a los consumidores de API navegar fácilmente por la documentación, detectar, acceder y consumir API desde el catálogo de API.
En la unidad siguiente, verá cómo puede crear y administrar el inventario de API con API Center mediante Azure Portal, en el entorno local mediante la CLI de Azure o en VS Code con la extensión API Center.