定义特定于目录的属性值

对于任何 API 属性,您都可以定义特定于特定目录的值。 对于发布到该目录的任何 API,API 属性采用特定于目录的值,覆盖任何缺省属性值。

准备工作

您必须已创建了该 API 属性,现在才可为其定义一个目录特定的值;请参阅 “设置 API 属性”

关于本任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息,请参阅 编辑 OpenAPI 3.0 API 定义

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

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

提示: 如果在已登台或已发布的 API 上添加或更改 API 属性,那么必须重新登台或重新发布包含已更新 API 的产品,以使更改生效。

过程

  1. 打开 API 以进行编辑,如 编辑 OpenAPI 2.0 API 定义中所述。
  2. 选择 网关 选项卡,展开 网关和门户网站设置 ,然后如果已定义一个或多个特定于目录的属性值,展开 目录属性
  3. 配置特定于目录的属性值。
    • 要定义新的特定于目录的属性值,请完成以下步骤:
      1. 点击导航窗格中 “目录属性 ”旁边的“添加 OpenAPI 2.0 API 添加图标 ”图标。
      2. 输入在所选目录的 name 字段中显示的 目录名称
        提示: 为了获得最佳结果,请手动输入目录的名称,而不是选择其标题。 使用目录名称比使用其标题更安全,因为该标题在提供者组织中可能不是唯一的,稍后可能会进行修改 (这将破坏属性与目录之间的关联)。 目录的名称在提供者组织中始终唯一,无法更改。
      3. 点击 “创建”。 这样会显示指定目录的目录属性详细信息以供进一步编辑。
      4. 属性覆盖旁边,单击 添加
      5. 提供以下信息:
        • 要覆盖的属性名称: 输入要为其定义特定于目录的值的 API 属性的名称。 该名称必须与先前定义的 API 属性名称一致;请参阅 “设置 API 属性 ”。
        • 属性值:特定于目录的属性值。 如果属性在缺省情况下具有空值,请留空。
      6. 点击 “创建”
    • 要修改现有的特定于目录的属性值,请单击导航窗格中的目录名称。 然后,您可以更改目录名称,并添加、修改或删除属性覆盖设置。
  4. 单击保存以保存更改。