编辑响应

响应用于定义响应主体和头中返回的 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 语法 用于富文本格式表示。
    • :头定义可在响应中返回的信息。

      要为响应定义新头,请单击 添加,然后参阅 创建头

      要编辑现有头,请单击头名称,然后参阅 编辑头

    • 内容:内容定义描述响应的内容。

      要为响应定义新的内容定义,请单击 添加,然后参阅 创建内容定义

      要编辑现有内容定义,请单击内容定义名称,然后参阅 编辑内容定义

    • 链接:链接描述了一个操作返回的各种值如何用作其他操作的输入。

      要为响应定义新链接,请单击 添加,然后参阅 创建链接

      要编辑现有链接,请单击链接名称,然后参阅 编辑链接

  2. 完成后单击 保存

后续操作

如果需要,请使用面包屑跟踪以浏览至所处理对象的层次结构中的其他位置。