Aggiunta di un'estensione OpenAPI a un'API

Modifica online

Puoi estendere la specifica OpenAPI aggiungendo uno schema di estensione JSON o YAML a un'API. Un'estensione OpenAPI viene importata in un catalogo o in un spazio all'interno di un catalogo, quindi aggiunta allo schema API.

Prima di iniziare

Importa l'estensione OpenAPI nel catalogo Sandbox o in qualsiasi catalogo a cui verrà pubblicata l'API a cui stai aggiungendo l'estensione; vedi Importazione di un'estensione OpenAPI in un catalogo.

Informazioni su questa attività

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

Solo UI Gestore API : Per completare questa attività, è necessario disporre di un ruolo con autorizzazione Api-Drafts:Edit . Il ruolo di sviluppatore prefornito ha questa autorizzazione per impostazione predefinita; se ti viene assegnato un ruolo personalizzato, deve avere questa autorizzazione. Per ulteriori informazioni, consultare Creazione di ruoli personalizzati.

Procedura

  1. Nel riquadro di navigazione, fare clic su Icona di sviluppo nel riquadro di navigazione dell'interfaccia utente API "Sviluppo ", quindi selezionare la scheda "API".
  2. Fai clic sul titolo dell'API che vuoi utilizzare.
  3. Selezionare la scheda Gateway , espandere Impostazioni gateway e portale, quindi fare clic su Estensioni.
  4. Seleziona le estensioni OpenAPI che vuoi utilizzare con questa API e fai clic su Salva.
    Nota: le estensioni " OpenAPI " elencate sono quelle che sono state importate nel Catalogo e nel servizio gateway definiti nelle preferenze di test per l'API; si vedano le sezioni Importazione di un'estensione " OpenAPI " in un Catalogo e Definizione delle preferenze di test per un'API. Dovrai anche importare l'estensione OpenAPI in qualsiasi catalogo in cui verrà pubblicata l'API.
  5. Aggiorna l'origine OpenAPI per la definizione API con i valori per i campi come definiti nei file dello schema di estensione OpenAPI selezionati, come segue:
    1. Fai clic sull'icona "Fonte Icona origine OpenAPI".
    2. Aggiungere una proprietà il cui nome deve iniziare per x- e fare riferimento al nome dell'estensione OpenAPI creata. Specifica i valori delle proprietà definite nel file YAML di estensione OpenAPI .
      Per un esempio, consultare la sezione "Riferimento a un'estensione in una definizione API"
    3. Fare clic su Salva una volta terminato.