Esta página se aplica a Apigee y Apigee Hybrid.
Acerca de las especificaciones de API
Las especificaciones de API usan formatos estándar para describir las APIs. Son legibles para las máquinas, pero también son fáciles de leer y comprender. Las especificaciones suelen describir elementos de una API, como su ruta base, las rutas y verbos, los encabezados, los parámetros de consulta, las operaciones, los tipos de contenido, las descripciones de respuesta, etcétera, como se muestra en la Figura 1.
Figura 1. Extracto de una especificación de OpenAPI.
Una versión de API puede contener varias especificaciones de API del mismo tipo o de tipos diferentes, como OpenAPI Spec, Proto y WSDL. Cuando es compatible, el concentrador de APIs puede analizar una especificación de API para extraer y almacenar metadatos de API, como el ID de la API, el ID de versión, la descripción y las operaciones. Consulta Análisis de especificaciones.
Usa especificaciones de API con el concentrador de APIs
Puedes crear una versión de API en el concentrador de APIs con o sin una especificación de API.
Puedes subir una especificación cuando creas una versión. Cuando veas los detalles de una API en la interfaz de usuario, verás una lista de las especificaciones asociadas con las versiones de un recurso de API.
También puedes crear y configurar una versión con una especificación mediante la API de REST. Cuando usas la API, creas una entidad de versión de API con la especificación y, luego, adjuntas la versión a un recurso de API.
Para obtener más información, consulta Agrega una especificación a una versión.
Análisis de especificaciones
Cuando es compatible, el concentrador de APIs puede analizar una especificación de API para extraer información sobre la API y almacenarla con una versión de la API. Por ejemplo, el concentrador de APIs puede analizar una especificación de OpenAPI de la API para extraer y almacenar el ID de la API, el ID de versión, la descripción, las operaciones y otros metadatos.
El centro de APIs también admite la validación de especificaciones. Consulta Valida una especificación de API.