Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Crea e convalida le specifiche OpenAPI senza scrivere codice utilizzando l'editor delle specifiche.
Accedere all'editor delle specifiche
Apri una specifica OpenAPI nell'editor delle specifiche, come descritto nelle sezioni seguenti:
- Crea una nuova specifica OpenAPI
- Importare una specifica OpenAPI
- Modificare una specifica OpenAPI esistente
La figura seguente mostra la specifica dell'API Petstore aperta nell'editor delle specifiche:
Come evidenziato nella figura precedente, l'editor delle specifiche ti consente di:
- Crea la specifica OpenAPI per modellare la tua API utilizzando il formato JSON o YAML nel riquadro a sinistra.
- Visualizza la documentazione dell'API generata automaticamente nel riquadro a destra.
- Convalida la specifica in base allo standard della specifica OpenAPI durante la digitazione.
- Salva la specifica OpenAPI o chiudi la specifica e annulla le modifiche.
Aiutami con JSON e YAML
JSON (JavaScript Object Notation) è un formato di scambio di dati leggero utilizzato per rappresentare semplici strutture di dati e array associativi. Per scoprire di più, visita la pagina https://www.json.org.
YAML (YAML Ain't Markup Language) è uno standard di serializzazione/rappresentazione dei dati che fornisce una sintassi che può essere mappata a strutture di dati, come elenchi, array associativi e scalari. Per saperne di più, visita la pagina https://yaml.org.
JSON e YAML sono leggibili dal computer, ma anche facili da leggere e comprendere per gli esseri umani. La figura seguente confronta due brevi estratti della stessa specifica OpenAPI scritti utilizzando JSON e YAML:
Convalidare una specifica
L'editor delle specifiche convalida la specifica OpenAPI in base allo standard della specifica OpenAPI. Mentre digiti, se ci sono errori nella specifica OpenAPI, l'editor delle specifiche mostra la finestra di dialogo Errore nella parte superiore del riquadro di destra e fornisce ulteriori informazioni sugli errori e sui numeri di riga associati in modo che tu possa correggerli facilmente.
Salvare una specifica
Per salvare una specifica OpenAPI, fai clic su Salva nella barra di navigazione in alto.
Se è la prima volta che salvi la specifica, ti viene chiesto di inserire un nome file. Se non specifichi un nome file, il nome predefinito è Untitled. Puoi rinominarlo in un secondo momento.
Chiudere una specifica
Per chiudere una specifica OpenAPI senza salvare le modifiche, fai clic su Annulla nella barra di navigazione in alto. Tornerai all'elenco delle specifiche.