Introduzione alle specifiche dell'API

Questa pagina si applica a Apigee e Apigee ibrido.

Informazioni sulle specifiche dell'API

Le specifiche delle API utilizzano formati standard per descrivere le API. Sono leggibili dalle macchine, ma anche facili da leggere e comprendere per le persone. Le specifiche in genere descrivono elementi di un'API come percorso di base, percorsi e verbi, intestazioni, parametri di ricerca, operazioni, tipi di contenuti, descrizioni delle risposte e così via.

Una versione API può contenere più specifiche API dello stesso tipo o di tipi diversi, come OpenAPI Spec, Proto e WSDL. Se supportato, l'hub API può analizzare una specifica API per estrarre e archiviare i metadati dell'API, come l'ID API, l'ID versione, la descrizione e le 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 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 API con la specifica, quindi puoi collegare la versione a una risorsa API.

Per ulteriori informazioni, consulta Aggiungere una specifica a una versione.

Analisi delle specifiche

Se supportato, l'hub API può analizzare una specifica API per estrarre informazioni sull'API e archiviarle con una versione 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.