Supporto per OpenAPI Specification 3.0
OpenAPI Specification 3.0 include nuove funzionalità, offrendo maggiore espressività e produttività ai progettisti di API.
Per ulteriori informazioni su OpenAPI, consultare la documentazione di Swagger.
Componenti
- Variabili di percorso
- Parametri di query
- Intestazioni
- Risposte
Combinazioni
- La composizione (allOf) consente di aggregare le proprietà dello schema da schemi diversi. Ad esempio, è possibile definire un tipo di dati Company
riutilizzando tutte le proprietà dai tipi esistenti Contact
ed Error.
- Il polimorfismo (oneOf/anyOf) consente di creare un'entità che può utilizzare le
proprietà di diversi tipi di dati.
- oneOf consente di definire un tipo di dati contenente le
proprietà di uno dei tipi selezionati. Ad esempio, se si crea un'operazione per ottenere informazioni su un account di servizio, è possibile definire la
risposta utilizzando la combinazione oneOf per ottenere tutte le
proprietà di Error o tutte le proprietà di
ServiceAccountCount.
- anyOf consente di definire un tipo di dati contenente le
proprietà di uno o più dei tipi selezionati. Ad esempio, è possibile
definire un tipo di dati nervousSystem e un tipo
skeleton contenenti proprietà diverse e utilizzare
la combinazione anyOf per creare un tipo di dati contenente qualsiasi
proprietà da uno di questi tipi.
Una combinazione anyOf è valida purché contenga tutti i parametri richiesti di almeno uno dei tipi di dati selezionati. L'esempio seguente utilizza la proprietà brain_weight dal tipo nervousSystem e le proprietà skull_height e teeth da skeleton.
- oneOf consente di definire un tipo di dati contenente le
proprietà di uno dei tipi selezionati. Ad esempio, se si crea un'operazione per ottenere informazioni su un account di servizio, è possibile definire la
risposta utilizzando la combinazione oneOf per ottenere tutte le
proprietà di Error o tutte le proprietà di
ServiceAccountCount.
Per ulteriori informazioni su composizione e polimorfismo, consultare Ereditarietà e polimorfismo e Differenza tra anyOf e oneOf.
Risposte
- Intervalli di risposta: invece di definire una risposta come 200, è possibile impostarla come 2XX, in modo che includa le risposte da 200 a 299.
- Risposte predefinite: è possibile definire una risposta predefinita da restituire quando non è definita una risposta specifica o un intervallo.
- La risposta 204 è definita e ha la precedenza sulle altre.
- La risposta 2XX si applica ai codici di risposta da 200 a 203 e da 205 a 299.
- La risposta default si applica a tutte le risposte 1XX, 3XX, 4XX e 5XX.
Sicurezza
- Autenticazione Bearer
- OpenIdConnect
Restrizioni
OAS 3.0 consente di indicare che alcune proprietà sono di sola lettura o di sola scrittura.
Questa opzione è disponibile solo nei tipi di dati e non può essere definita nelle richieste o nelle risposte a livello di operazione.
