Specifica della documentazione esterna per una operazione

Puoi fare riferimento a una risorsa esterna per la documentazione estesa per un'operazione API.

Informazioni su questa attività

Nota:

Questa attività è correlata a una definizione API OpenAPI 3.0 . Per i dettagli su come configurare una definizione API OpenAPI 2.0 , vedi Modifica di una definizione API OpenAPI 2.0.
Le API OpenAPI 3.0 sono supportate solo con DataPower® API Gateway, non con DataPower Gateway (v5 compatible).
Per i dettagli sulle limitazioni correnti del supporto OpenAPI 3.0 , vedi OpenAPI 3.0 support in IBM® API ConnectAI Gateway.

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 modulo Modulo.

Procedura

Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 3.0.
espandere Percorsi, quindi espandere il percorso richiesto.
Espandere Operazioni, espandere l'operazione richiesta e fare clic su Documentazione esterna.
Fornisci le seguenti informazioni:
- URL (obbligatorio): L' URL a per la documentazione di destinazione.
- Descrizione: una descrizione facoltativa della documentazione di destinazione. È possibile utilizzare la sintassi CommonMark per la rappresentazione in formato RTF.
Fare clic su Salva una volta terminato.