Defining the request body for an operation
A request body defines the structure of the body of an API request.
About this task
Note:
- This task relates to configuring an OpenAPI 3.0 API definition. For details on how to configure an OpenAPI 2.0 API definition, see Editing an OpenAPI 2.0 API definition.
- OpenAPI 3.0 APIs are supported only with the DataPower® API Gateway, not with the DataPower Gateway (v5 compatible).
- For details of current OpenAPI 3.0 support limitations, see OpenAPI 3.0 support in IBM® API Connect.
You can complete this task either by using the API Designer UI application, or by using the browser-based API Manager UI.
At any time, you can switch directly to the underlying OpenAPI YAML
source by clicking the Source icon .
To return to the design form, click the Form icon
.
Note: The user interface doesn't currently support referencing a request body component from an
operation. However, you can add the reference directly to the OpenAPI YAML source for your API
definition, for
example:
paths:
/mypath:
get:
.
.
.
requestBody:
$ref: '#/components/requestBodies/my_requestbody_component'
.
.
.
For information on request body components, see Defining request body components.