Creazione di un corpo della richiesta

Un corpo della richiesta definisce la struttura del corpo di una richiesta API.

Prima di iniziare

Aprire la finestra di creazione del corpo della richiesta; vedere Definizione dei componenti del corpo della richiesta.

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

Creare il corpo della richiesta; è possibile creare un corpo della richiesta da zero oppure è possibile fare riferimento a un corpo della richiesta definito in un componente del corpo della richiesta.
- Per creare il corpo della richiesta da zero, fornire le seguenti informazioni nella scheda Definizione :
  - Nome: un nome per il corpo della richiesta.
    Se si sta creando un componente del corpo della richiesta, questo nome definisce una chiave che consente a questo corpo della richiesta di fare riferimento altrove nella definizione API; il riferimento ha il seguente formato:
    #/components/requestBodies/Name
  - Descrizione: una descrizione del corpo della richiesta. È possibile utilizzare la sintassi CommonMark per la rappresentazione in formato RTF.
  - Obbligatorio: determina se il corpo della richiesta è richiesto nella richiesta.
- Per fare riferimento a un corpo della richiesta definito in un componente del corpo della richiesta, fornire le seguenti informazioni nella scheda Riferimento :
  - Nome: un nome per il corpo della richiesta.
    Se si sta creando un componente del corpo della richiesta, questo nome definisce una chiave che consente a questo corpo della richiesta di fare riferimento altrove nella definizione API; il riferimento ha il seguente formato:
    #/components/requestBodies/Name
  - Riferimento da: selezionare un riferimento ad un componente del body della richiesta.
Fare clic su Crea.
I dettagli del corpo della richiesta vengono visualizzati per consentire ulteriori modifiche; vedere Modifica del corpo di una richiesta.