Specifica dei metadati API

I metadati API forniscono informazioni di riepilogo sull'API. Immetti i metadati API nella sezione Info della definizione API.

Informazioni su questa attività

Nota:

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 al codice sorgente YAML sottostante dell' OpenAPI, cliccando Icona origine OpenAPI sull'icona "Sorgente". Per tornare al modulo di progettazione, clicca sull'icona Icona moduloModulo.

Procedura

  1. Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 3.0.
  2. Espandere la sezione Generale e fare clic su Info.
  3. Fornisci le seguenti informazioni:
    • Titolo (obbligatorio): il titolo dell'API.
    • Nome: il nome è stato generato automaticamente quando l'API è stata creata e non può essere modificato. Il valore nel campo Nome è una stringa singola utilizzata per identificare l'API nei comandi CLI developer toolkit . Per visualizzare i comandi CLI per la gestione delle API in bozza, consultare la documentazione di riferimento della CLI del toolkit.
    • Versione: la versione API viene specificata quando l'API viene inizialmente creata e non può essere modificata successivamente. È tuttavia possibile creare una nuova versione di un'API esistente; vedere Creazione di una nuova versione di una definizione di API.
    • Descrizione: una descrizione facoltativa dell'API. È possibile utilizzare la sintassi CommonMark per la rappresentazione in formato RTF.
    • Termini di servizio : Un' URL e ai Termini di servizio per l'API.
    • Nome contatto: il nome identificativo della persona / organizzazione di contatto.
    • Contatti URL : Un collegamento ipertestuale ( URL ) che rimanda alle informazioni di contatto.
    • E-mail di contatto: l'indirizzo e-mail della persona/organizzazione di contatto.
    • Nome licenza: il nome della licenza utilizzato per l'API.
    • Licenza URL : un' URL e alla licenza utilizzata per l'API.
  4. Fare clic su Salva una volta terminato.