Creazione di definizioni di schemi

Gli schemi forniscono agli sviluppatori informazioni sulla richiesta che devono effettuare o sulla risposta che devono aspettarsi di ricevere quando richiamano un'operazione API. È possibile creare schemi in varie posizioni nella definizione API.

Prima di iniziare

Nota: gli schemi vengono compilati prima di essere utilizzati per la convalida. Poiché il processo di compilazione è più lungo del processo di convalida, le risorse utente dello schema compilato vengono memorizzate in una cache. La capacità limitata della cache può causare l'eliminazione delle voci più vecchie dalla cache quando vengono aggiunte voci più nuove. Gli schemi le cui risorse sono state rimosse dalla cache devono essere ricompilati, il che può causare ritardi significativi nella convalida.
Per i dettagli delle aree nella tua definizione API da cui puoi creare uno schema, consulta i seguenti argomenti:

Informazioni su questa attività

Nota: questa attività fa riferimento alla configurazione di una definizione API OpenAPI 2.0 . Per i dettagli su come configurare una definizione API OpenAPI 3.0 , vedi Modifica di una definizione API OpenAPI 3.0.

Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.

In qualsiasi momento, puoi passare direttamente all'origine YAML OpenAPI sottostante facendo clic sull'icona Origine Icona origine OpenAPI. Per tornare al modulo di progettazione, fare clic su Modulo Icona modulo.

Procedura

  1. Per creare una definizione di schema, fare clic sull'icona Aggiungi Icona OpenAPI 2.0 API add accanto Definizioni.
    Viene visualizzata la procedura guidata Aggiungi oggetto per uno schema.
  2. Immettere le seguenti informazioni:
    • Nome schema: questo nome definisce una chiave che consente di fare riferimento a questo schema da un altro punto della definizione API; il riferimento ha il seguente formato:
      #/definitions/Name
    • Titolo: il titolo dello schema.
    • Tipo: il tipo di dati dello schema; selezionare uno dei seguenti:
      • schiera
      • booleano
      • intero
      • numero
      • oggetto
      • stringa
  3. Fare clic su Crea.
    I dettagli delle definizioni di schemi vengono visualizzati per ulteriori modifiche; consultare Modifica delle definizioni di schema.