Supporto per OpenAPI Specification 3.0 | Guida di Qlik Cloud
Vai al contenuto principale Passa a contenuto complementare
Risorse Qlik
Caricamento ricerca di SearchUnify Per assistenza con il prodotto, contattare il Supporto Qlik.
Portale cliente Qlik
Caricamento ricerca di SearchUnify Per assistenza con il prodotto, contattare il Supporto Qlik.
Portale cliente Qlik

Supporto per OpenAPI Specification 3.0

Ultimo aggiornamento: 20/10/2026
Progetta un'API con OpenAPI Specification (OAS) 3.0 utilizzando i contratti API.

OpenAPI Specification 3.0 introduce nuove funzionalità, offrendo maggiore espressività e produttività ai progettisti di API.

Per ulteriori informazioni su OpenAPI, consulta la documentazione di Swagger.

Componenti

I componenti consentono di riutilizzare vari elementi all'interno di un'API. Questi elementi possono essere:
  • Variabili di percorso
  • Parametri query
  • Intestazioni
  • Risposte

Combinazioni

Le combinazioni consentono di creare un nuovo tipo di dati combinando diversi altri tipi di dati. API Contracts supporta due tipi di 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à dei tipi esistenti Contact e Error.
    Esempio di composizione.
  • Il polimorfismo (oneOf/anyOf) consente di creare un'entità in grado di 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.
      Esempio di polimorfismo.
    • anyOf consente di definire un tipo di dati contenente le proprietà di uno o diversi 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à di 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 del tipo nervousSystem e le proprietà skull_height e teeth di skeleton.

      Esempio di combinazione che utilizza i tipi di dati nervousSystem e skeleton.

Per ulteriori informazioni sulla composizione e sul polimorfismo, vedere Ereditarietà e polimorfismo e Differenza tra anyOf e oneOf.

Risposte

OAS 3.0 consente di definire nuovi tipi di risposta per le tue operazioni:
  • Intervalli di risposta: invece di definire una risposta come 200, è possibile impostarla come 2XX, in modo da includere le risposte da 200 a 299.
  • Risposte predefinite: è possibile definire una risposta predefinita da restituire quando non è definita una risposta specifica o per intervallo.
Le risposte definite con un codice esplicito hanno la precedenza sugli intervalli di risposta e sulle risposte predefinite, e gli intervalli di risposta hanno la precedenza sulle risposte predefinite. Nell'esempio seguente:
  • 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 predefinita si applica a tutte le risposte 1XX, 3XX, 4XX e 5XX.
Sezione Risposte.

Sicurezza

OAS 3.0 introduce nuovi schemi di sicurezza per la tua API:
  • Autenticazione Bearer
  • OpenIdConnect

Limitazioni

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 in richieste o risposte a livello di operazione.

Esempio di restrizione.

Hai trovato utile questa pagina?

Se riscontri problemi con questa pagina o con il suo contenuto – un errore di battitura, un passaggio mancante o un errore tecnico – ti pregiamo di farcelo sapere!

Lascia qui il tuo feedback