创建响应

响应用于定义响应主体和头中返回的 HTTP 状态码和数据。 您可以在 API 定义中为路径操作创建响应。

准备工作

启动响应创建窗口。 有关 API 定义中可创建响应的区域详细信息，请参阅以下主题：

关于此任务

注：
  • 此任务与配置 OpenAPI 3.0 API 定义相关。 有关如何配置 OpenAPI 2.0 API 定义的详细信息，请参阅 编辑 OpenAPI 2.0 API 定义。
  • OpenAPI 3.0 API 仅支持 DataPower® API Gateway，而不支持 DataPower Gateway (v5 compatible)。
  • 有关当前 OpenAPI 3.0 支持限制的详细信息，请参阅 IBM® API Connect 中的 OpenAPI 3.0 支持。

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

您可以随时通过单击 源 图标 OpenAPI 源图标直接切换到底层 OpenAPI YAML 源。 要返回到设计表单，请单击 表单 图标 表单图标。

过程

  1. 创建响应；您可以从头开始创建响应，也可以引用响应组件中定义的响应。
    • 要从头开始创建响应，请在定义选项卡上提供以下信息：
      • 响应名称: 响应的名称。

        如果要创建操作响应，那么此名称为 HTTP 状态码。

        如果要创建响应组件，那么此名称定义一个键，该键支持在 API 定义中的其他位置引用此响应；该引用具有以下格式：
        #/components/responses/Name
      • 描述 (必需): 响应的描述。 您可以将 CommonMark 语法 用于富文本格式表示。
    • 要引用在响应组件中定义的响应，请在引用选项卡上提供以下信息：
      • 响应名称: 响应的名称。

        如果要创建操作响应，那么此名称为 HTTP 状态码。

        如果要创建响应组件，那么此名称定义一个键，该键支持在 API 定义中的其他位置引用此响应；该引用具有以下格式：
        #/components/responses/Name
      • 引用来源：选择对响应组件的引用。
  2. 单击 创建。
    将显示响应详细信息以进行进一步编辑; 请参阅 编辑响应。