Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Crea e convalida le specifiche OpenAPI senza scrivere codice utilizzando l'editor delle specifiche.
Accesso 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 per l'API Petstore aperta nell'editor delle specifiche:
Come evidenziato nella figura precedente, l'editor delle specifiche ti consente di:
- Crea la tua specifica OpenAPI per modellare l'API utilizzando il formato JSON o YAML nel riquadro di sinistra.
- Visualizza la documentazione dell'API generata automaticamente nel riquadro di destra.
- Convalida la tua 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 leggero per lo scambio di dati utilizzato per la rappresentazione di strutture di dati semplici e array associativi. Per scoprire di più, visita https://www.json.org.
YAML (YAML Ain't Markup Language) è uno standard di serializzazione/rappresentazione dei dati che fornisce una sintassi che fornisce anche una sintassi che può essere mappata a strutture di dati, come elenchi, array associativi e scalari. Per saperne di più, visita https://yaml.org.
Sia i file JSON che YAML sono leggibili dalla macchina, ma sono anche facili da leggere e comprendere per le persone. La figura seguente mette a confronto due brevi estratti della stessa specifica OpenAPI scritti utilizzando JSON e YAML:
Convalidare una specifica
L'editor delle specifiche convalida la tua specifica OpenAPI in base allo standard delle specifiche OpenAPI. Se durante la digitazione sono presenti errori nella specifica OpenAPI, l'editor delle specifiche visualizza la finestra di dialogo Errore nella parte superiore del riquadro di destra e fornisce ulteriori informazioni sugli errori e sui relativi numeri di riga associati in modo che tu possa correggerli facilmente.
Salva 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 valore predefinito sarà Senza titolo. Potrai rinominarla in un secondo momento.
Chiudi 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.