创建链接

在线编辑

链接描述了一个操作返回的各种值如何用作其他操作的输入，提供了操作之间的已知关系和遍历机制。

准备工作

启动链接创建窗口。 有关 API 定义中可创建链接的区域详细信息，请参阅以下主题：

关于本任务

注：

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

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

过程

  1. 创建链接；您可以从头开始创建链接，也可以引用链接组件中定义的链接。
    • 要从头开始创建链接，请在定义选项卡上提供以下信息：
      • 名称：如果要创建链接组件，那么此名称定义一个键，该键支持在 API 定义中的其他位置引用此链接；该引用具有以下格式：
        #/components/links/Name
      • 操作标识：现有操作的标识；此字段与操作引用字段互斥。 有关定义操作的详情，请参阅为路径定义操作。
      • 操作引用：对现有操作的相对或绝对 URI 引用；此字段与操作标识字段互斥。 有关定义操作的详细信息，请参阅 “为路径定义操作 ”。
      • 描述: 链接的描述。 您可以使用 CommonMark 语法来呈现富文本。
    • 要引用在链接组件中定义的链接，请在引用选项卡上提供以下信息：
      • 名称：如果要创建链接组件，那么此名称定义一个键，该键支持在 API 定义中的其他位置引用此链接；该引用具有以下格式：
        #/components/links/Name
      • 引用来源：选择对链接组件的引用。
  2. 单击 创建。
    链接详细信息已显示，以便进行进一步编辑；请参阅 “编辑链接 ”。