Defining schema definitions for an API
Schema components define reusable schemas that provide developers with information about the request they should make, or the response they should expect to receive, when calling an API operation.
About this task
An API created in OpenAPI 2.0 includes a section where API payload definitions are defined. The payload definitions describe the structure of data transmitted in API requests and responses, utilizing a specialized JSON schema variant specific to OpenAPI. Each payload definition corresponds to a schema, which lists the expected data fields. These data fields are represented as properties within the schema and include a set of attributes that describe their type, permissible values, mandatory status, and other characteristics. Although numerous attributes are available, the majority of them are infrequently utilized.
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 
.
Procedure
- You can create a new schema, or edit any existing schema.
- To create a schema, click the add icon
alongside Definitions, then
refer to Creating schema definitions. - To edit an existing schema, click the schema component name in the navigation pane, then refer to Editing schema definitions.
- To create a schema, click the add icon