Questa pagina si applica ad Apigee e Apigee hybrid.
Informazioni sulle specifiche dell'API
Le specifiche API utilizzano formati standard per descrivere le API. Sono leggibili dalle macchine, ma anche facili da leggere e comprendere per le persone. Le specifiche descrivono in genere gli elementi di un'API, come il percorso di base, i percorsi e i verbi, gli header, i parametri di ricerca, le operazioni, i tipi di contenuti, le descrizioni delle risposte e così via, come mostrato nella Figura 1.
Figura 1. Estratto da una specifica OpenAPI.
Una versione dell'API può contenere più specifiche API dello stesso tipo o di tipi diversi, ad esempio specifica OpenAPI, Proto e WSDL. Se supportato, l'hub API può analizzare una specifica dell'API per estrarre e archiviare i metadati dell'API, ad esempio l'ID API, l'ID versione, la descrizione e le operazioni. Consulta la sezione Analisi delle specifiche.
Utilizzo delle specifiche dell'API con l'hub API
Puoi creare una versione dell'API in API Hub con o senza una specifica API.
Puoi caricare una specifica al momento della creazione di 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 dell'API con la specifica, quindi puoi associare la versione a una risorsa dell'API.
Per ulteriori informazioni, vedi 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 OpenAPI dell'API 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 Convalidare una specifica dell'API.