为 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. 打开 API 以进行编辑，如 编辑 OpenAPI 3.0 API 定义中所述。
  2. 展开 常规 部分，然后单击 外部文档。
  3. 提供以下信息：
    • URL（必需）：目标文档的 URL。
    • 描述：目标文档的可选描述。 您可以使用 CommonMark 语法来呈现富文本。
  4. 完成后单击 保存 。