定义 API 的响应

响应用于定义响应主体和头中返回的 HTTP 状态码和数据。 为 API 定义的响应可以跨操作使用。

关于此任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息,请参阅 编辑 OpenAPI 3.0 API 定义

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

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

过程

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