为 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 来完成此任务。

您可以定义多个服务器,但只有第一个服务器由 API Connect使用。

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

过程

  1. 打开 API 以进行编辑,如 编辑 OpenAPI 3.0 API 定义中所述。
  2. 展开 常规 ,如果已定义一个或多个服务器,请展开 服务器
  3. 要创建新的服务器定义,请单击导航窗格中 服务器 旁边的 "添加" 图标 OpenAPI 3.0 API 添加图标 。 要编辑现有服务器定义,请单击导航窗格中的服务器 URL。
  4. 提供以下信息:
    • 服务器 URL(必需):所指定 URL 用于在考虑 API 发布目录中的任何虚端点配置的情况下,确定用于调用 API 的完整 URL 端点。 对于由 DataPower API Gateway实施的 API ,此处输入的值将解释为基本路径,因此您通常仅提供基本路径值; 例如:
      /my_basepath
      有关如何使用服务器 URL 确定完整 URL 端点的详细信息,请参阅为目录配置虚终端
    • 服务器描述:URL 所指定主机的可选描述。 您可以使用 CommonMark 语法来表示富文本。
    • 服务器变量(编辑现有服务器定义时可用):服务器变量定义变量名称与其值之间的映射。 该值用于在服务器的 URL 模板中进行替换。
      1. 要添加新的服务器变量,请单击 添加。 要编辑现有服务器变量,请单击该变量名称。
      2. 提供以下信息:
        • 服务器变量名称 (必需)。
        • 缺省 值 (必需)。
        • 可选富文本格式描述。 您可以将 CommonMark 语法 用于富文本格式表示。
        • 一个或多个枚举值条目(编辑现有服务器变量时可用)。 枚举值指定在替换选项来自有限集合时要使用的字符串值的枚举。 要添加新的枚举值,请单击添加,输入值,然后单击创建。 要编辑现有枚举值,请单击该枚举值。
      3. 如果要创建新的服务器变量,请单击创建。 这样会显示服务器变量详细信息以供进一步编辑。
      4. 如果需要,请使用面包屑跟踪返回到服务器定义进行进一步编辑。
  5. 如果要创建新的服务器定义,请单击 创建
    将显示服务器定义详细信息以进行进一步编辑,如步骤 4中所述。
  6. 完成后单击 保存