Definizione del corpo della richiesta per un'operazione

Un corpo della richiesta definisce la struttura del corpo di una richiesta 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 Connect.

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 .

Nota: l'interfaccia utente attualmente non supporta il riferimento a un componente del corpo della richiesta da un'operazione. Tuttavia, puoi aggiungere il riferimento direttamente all'origine YAML OpenAPI per la tua definizione API, ad esempio:

paths:
  /mypath:
    get:
          .
          .
          .
      requestBody:
        $ref: '#/components/requestBodies/my_requestbody_component'
          .
          .
          .

Per informazioni sui componenti del corpo della richiesta, consultare Definizione dei componenti del corpo della richiesta.

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, quindi fare clic su requestBody.
Immettere le seguenti informazioni:
- Descrizione: una descrizione facoltativa del corpo della richiesta. Questo potrebbe contenere esempi di utilizzo. È possibile utilizzare la sintassi CommonMark per la rappresentazione rich text.
- Contenuto: una definizione di contenuto descrive il contenuto del corpo della richiesta.
  Per definire una nuova definizione di contenuto per il corpo della richiesta, fare clic su Aggiungi, quindi fare riferimento a Creazione di una definizione di contenuto.
  
  Per modificare una definizione del contenuto esistente, fare clic sul nome della definizione del contenuto, quindi fare riferimento a Modifica di una definizione del contenuto.
- Obbligatorio: determina se il corpo della richiesta è richiesto nella richiesta.
Fare clic su Salva una volta terminato.