Creating a response

Responses define the HTTP status code and data returned in a response body and headers. You can create responses for the Path operations in your API definition.

Before you begin

Launch the response creation window. For details of the areas in your API definition from where you can create a response, see the following topics:

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 OpenAPI Source icon. To return to the design form, click the Form icon Form icon.

Procedure

  1. Create the response; you can either create a response from scratch, or you can reference a response that is defined in a response component.
    • To create the response from scratch, provide the following information on the Definition tab:
      • Response name: A name for the response.

        If you are creating an operation response, this name is the HTTP status code.

        If you are creating a response component, this name defines a key that enables this response to be referenced from elsewhere in the API definition; the reference has the following format:
        #/components/responses/Name
      • Description (required): A description of the response. You can use CommonMark syntax for rich text representation.
    • To reference a response that is defined in a response component, provide the following information on the Reference tab:
      • Response name: A name for the response.

        If you are creating an operation response, this name is the HTTP status code.

        If you are creating a response component, this name defines a key that enables this response to be referenced from elsewhere in the API definition; the reference has the following format:
        #/components/responses/Name
      • Reference from: Select a reference to a response component.
  2. Click Create.
    The response details are displayed for further editing; see Editing a response.