Specifying the MIME types that an API consumes

You can specify which types of media your API will accept when calls are made to it. The API Connect gateway supports XML and JSON.

About this task

Note: This task relates to configuring an OpenAPI 2.0 API definition. For details on how to configure an OpenAPI 3.0 API definition, see Editing an OpenAPI 3.0 API definition.

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 that corresponds to the design form in the user interface by clicking the Source icon OpenAPI Source icon. To return to the design form, click the Form icon Form icon.

Procedure

  1. Open the required API for editing, as described in Editing an OpenAPI 2.0 API definition.
  2. Expand the General section then, if there are already one or more consumes MIME types defined, expand Consumes.
  3. To specify a new MIME type, click the add icon OpenAPI 2.0 API add icon alongside Consumes. To modify an existing MIME type, click the MIME type entry in the navigation pane.
  4. Enter the required value in the Mime Type field; for example, application/json or application/xml. Then click Create.
  5. Click Save when done.