定义响应组件

响应组件用于定义可复用的响应对象，这些对象指定在响应主体和头中返回的 HTTP 状态码和数据。

关于此任务

注：
  • 此任务与配置 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 来完成此任务。

要使用响应组件，必须在 API 定义中的其他位置引用该组件。

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

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 3.0 API 定义中所述。
  2. 展开 组件 ，如果已定义一个或多个响应组件，请展开 响应。
  3. 您可以创建新的响应组件，也可以编辑任何现有响应组件。
    • 要创建响应组件，请单击 响应旁边的 "添加" 图标 OpenAPI 3.0 API 添加图标 ，然后参阅 创建响应。
    • 要编辑现有响应组件，请单击导航窗格中的响应组件名称，然后参阅 编辑响应。