向 API 添加标记

在线编辑

可在 API 定义中包含标记。 此类标记将添加到 API 的 OpenAPI 定义中，但 API Connect 不会将其用于任何索引。

关于本任务

注：
  • 此任务与配置 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. 要添加新标签，请点击导航窗格中 “标签 ”旁边的添加 OpenAPI 3.0 API 添加图标 图标。 要编辑现有标记，请单击导航窗格中的标记名称。
  4. 提供以下信息：
    • Name (必需): 标记的名称。
    • 描述：标记的可选描述。 您可以使用 CommonMark 语法来呈现富文本。
    • 外部文档 > URL （编辑现有标记时可用）：描述该标记的目标文档 URL。
    • 外部文档 > 描述 （编辑现有标记时可用）：目标文档的可选描述。
  5. 如果要创建新标记，请单击 创建。
    将显示标记详细信息以进行进一步编辑，如步骤 4中所述。
  6. 完成后单击 保存 。