Cette page s'applique à Apigee et à Apigee hybrid.
À propos des spécifications d'API
Les spécifications d'API utilisent des formats standards pour décrire les API. Elles sont lisibles par une machine, mais sont également faciles à lire et à comprendre pour les humains. Les spécifications décrivent généralement les éléments d'une API, tels que son chemin de base, ses chemins et verbes, en-têtes, paramètres de requête, opérations, types de contenus, descriptions de réponse, etc., comme illustré dans la Figure 1.
Figure 1. Extrait d'une spécification OpenAPI.
Une version d'API peut contenir plusieurs spécifications d'API du même type ou de types différents, telles que Spécification OpenAPI, Proto et WSDL. Lorsque cela est possible, le hub d'API peut analyser une spécification d'API afin d'extraire et stocker les métadonnées de l'API, telles que l'ID de l'API, l'ID de la version, la description et les opérations. Consultez la section Analyse des spécifications.
Utiliser des spécifications d'API avec le hub d'API
Vous pouvez créer une version d'API dans le hub d'API avec ou sans spécification d'API.
Vous pouvez importer une spécification au moment où vous créez une version. Lorsque vous affichez les détails d'une API dans l'interface utilisateur, vous voyez la liste de toutes les spécifications associées aux versions d'une ressource d'API.
Vous pouvez également créer et configurer une version avec une spécification à l'aide de l'API REST. Lorsque vous utilisez l'API, vous créez une entité de version d'API avec la spécification, puis vous pouvez associer la version à une ressource d'API.
Pour en savoir plus, consultez la section Ajouter une spécification à une version.
Analyse des spécifications
Lorsque cela est possible, le hub d'API peut analyser une spécification d'API afin d'extraire des informations sur l'API et les stocker avec une version d'API. Par exemple, le hub d'API peut analyser une spécification d'API OpenAPI pour extraire et stocker l'ID de l'API, l'ID de la version, la description, les opérations et d'autres métadonnées.
Le hub d'API est également compatible avec la validation des spécifications. Consultez la section Valider une spécification d'API.