指定操作的外部文档

您可以引用外部资源以用作 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. 展开 操作，展开所需操作，然后单击 外部文档。
  4. 提供以下信息：
    • URL（必需）：目标文档的 URL。
    • 描述：目标文档的可选描述。 您可以将 CommonMark 语法 用于富文本格式表示。
  5. 完成后单击 保存 。