Centro de API de Azure: conceptos clave
En este artículo se explican los conceptos clave del Centro de API de Azure. El Centro de API de Azure permite realizar un seguimiento de las API en una ubicación centralizada para la detección, reutilización y gobernanza.
Modelo de datos
En el diagrama siguiente se muestran las entidades principales del Centro de API de Azure y cómo se relacionan entre sí. Consulte las secciones siguientes para saber más sobre estas entidades y conceptos relacionados.
API
Una API, una entidad lógica de nivel superior en el Centro de API de Azure, representa cualquier API del mundo real de la que quiera realizar un seguimiento. Un centro de API puede incluir API de cualquier tipo, como REST, GraphQL, gRPC, SOAP, WebSocket y Webhook.
Una API se puede administrar mediante cualquier solución de API Management (como Azure API Management o soluciones de otros proveedores) o no administrarse.
El inventario de API en el Centro de API de Azure está diseñado para crearse y administrarse mediante administradores de programas de API o administradores de TI.
Versión de API
El control de versiones de API es la práctica de administrar los cambios en una API y asegurarse de que estos cambios se realizan sin interrumpir a los clientes. Una API puede tener varias versiones en las fases del ciclo de vida, cada una alineada con cambios específicos de la API. Algunas versiones pueden introducir cambios sustanciales o importantes, mientras que otras agregan mejoras menores. Una versión de API puede estar en cualquier fase del ciclo de vida, desde el diseño, hasta la versión preliminar, la producción o el desuso.
Definición de la API
Idealmente, cada versión de API debe definirse mediante al menos una definición, como una definición de OpenAPI para una API de REST. El Centro de API de Azure permite cualquier archivo de definición de API con formato de texto (YAML, JSON, Markdown, etc.). Puede cargar definiciones de OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL y WADL, entre otras.
Entorno
Un entorno representa una ubicación en la que se podría implementar un entorno de ejecución de API, por ejemplo, un servicio Azure API Management, un servicio Apigee API Management o un servicio de proceso, como un clúster de Kubernetes, una aplicación web o una función de Azure. Cada entorno se alinea con una fase del ciclo de vida, como desarrollo, pruebas, ensayo o producción. Un entorno también puede incluir información sobre el portal para desarrolladores o las interfaces de administración.
Nota:
Use el Centro de API de Azure para realizar un seguimiento de cualquiera de sus entornos de tiempo de ejecución de API, independientemente de si se hospedan o no en la infraestructura de Azure. Estos entornos no son los mismos que los de Azure Deployment Environments.
Implementación
Una implementación es una ubicación (una dirección) donde los usuarios pueden acceder a una API. Una API puede tener varias implementaciones, como entornos de ensayo o regiones diferentes. Por ejemplo, una API podría tener una implementación en un entorno de ensayo interno y un segundo en un entorno de producción. Cada implementación está asociada a una definición de API específica.
Metadatos
En un Centro de API de Azure, puede organizar las API, las implementaciones y otras entidades estableciendo valores de metadatos, que se pueden usar para buscar, filtrar y aplicar los estándares de gobernanza. El Centro de API proporciona varias propiedades de metadatos integradas comunes, como "tipo de API" y "fase de ciclo de vida". Un propietario del Centro de API puede aumentar los metadatos integrados mediante la definición de metadatos personalizadas en un esquema de metadatos para organizar sus API, implementaciones y entornos. Por ejemplo, cree una propiedad de aprobador de API para identificar al individuo responsable de aprobar una API para su uso.
El Centro de API de Azure admite metadatos personalizados de tipo matriz, booleano, número, objeto, opciones predefinidas y cadena.
El esquema de metadatos del Centro de API de Azure es compatible con las especificaciones de esquema JSON y YAML, para permitir la validación de esquemas en las herramientas de desarrollador y las canalizaciones automatizadas.