Questa pagina si applica ad Apigee e Apigee hybrid.
Informazioni sulle specifiche API
Le specifiche API utilizzano formati standard per descrivere le API. Sono leggibili dalle macchine, ma anche facili da leggere e comprendere per gli esseri umani. Le specifiche in genere descrivono gli elementi di un'API come il percorso di base, i percorsi e i verbi, le intestazioni, parametri di ricerca, le operazioni, i tipi di contenuti, le descrizioni delle risposte e così via.
Una versione API può contenere più specifiche API dello stesso tipo o di tipi diversi, ad esempio specifiche OpenAPI, Proto e WSDL. Se supportato, l'hub API può analizzare una specifica API per estrarre e archiviare i metadati dell'API, come ID API, ID versione, descrizione e operazioni. Consulta la sezione Analisi delle specifiche.
Utilizzo delle specifiche API con l'hub API
Puoi creare una versione API nell'hub API con o senza una specifica API.
Puoi caricare una specifica nel momento in cui crei una versione. Quando visualizzi i dettagli di un'API nell'interfaccia utente, vedrai un elenco di tutte le specifiche associate alle versioni di una risorsa API.
Puoi anche creare e configurare una versione con una specifica utilizzando l'API REST. Quando utilizzi l'API, crei un'entità di versione API con la specifica, quindi puoi collegare la versione a una risorsa API.
Per saperne di più, consulta Aggiungere una specifica a una versione.
Analisi delle specifiche
Se supportato, l'hub API può analizzare una specifica dell'API per estrarre informazioni sull'API e archiviarle con una versione dell'API. Ad esempio, l'hub API può analizzare una specifica API OpenAPI per estrarre e archiviare l'ID API, l'ID versione, la descrizione, le operazioni e altri metadati.
L'hub API supporta anche la convalida delle specifiche. Consulta la sezione Convalidare una specifica API.