跳到主要内容

API Governance 规则

Postman Enterprise 计划提供可配置的 Governance 规则。 如果你没有企业帐户，你将能够看到 API Governance 页面，但你将无法打开或关闭规则或添加新规则。

你可以自定义 Postman 应用于你的 API 定义的 API Governance 规则。在 API 生命周期开始时遵守这些 API Governance 规则可使你的 API 保持一致，而无需在后期阶段进行额外工作。这可以防止你的组织出现不必要的延误。

只有具有 开发人员角色的 团队管理员才能为其团队管理 API Governance 规则。

API Governance仪表板

访问可配置的 API Governance 规则​

  1. 转到 Postman 主屏幕 。
  2. 从团队信息窗格中选择API Governance。

将规则添加到你的 API Governance 配置​

除了 Postman 中默认开启的规则外，你还可以从规则库中将其他规则添加到你团队的规则库中。你还可以创建自己的自定义规则。

从规则库导入规则​

规则库包含 Postman 的 API Governance 指南和 Zalando 的 RESTful API 和事件指南。导航到 Governance 仪表板 ，然后选择导入以打开规则库。

你可以选择一组准则下方的查看全部以查看其所有规则。规则名称下提供了详细信息和 API 格式要求。选择规则旁边的导入以将其导入。要导入一组特定指南的所有规则，请选择“全部导入”。

从 Postman 库导入 API Governance规则

从库中导入新规则后，你需要在 API Governance 仪表板中 启用它们。

添加自定义规则​

你可以为 Postman 创建新的自定义 Governance 规则来评估 API 的定义。Postman 为你提供样板规则，以帮助你开始编写自定义 Governance 规则。你还可以使用常用属性值对的片段来帮助你编写自定义 Governance 规则。

要添加自定义规则，请执行以下操作：

  1. 转到 Postman 主屏幕 ，然后从团队信息窗格中选择API Governance。

  2. 选择规则库选项卡。

  3. 选择创建规则。

  4. 在编辑器中定义规则。它必须遵守 自定义规则准则 。

    你可以使用精选的常用属性值对片段列表来编写你的规则。片段在编辑器的右窗格中可用。选择一个片段会将属性值对自动添加到你的规则中，帮助你快速开始编写规则。添加到你的规则后，你可以编辑片段以满足你的特定要求。

    当你输入文本时，Postman 会提示你一些建议。选择一个自动完成你的规则。

  5. 规则必须是有效的 YAML 或 JSON。使用下拉列表选择正确的语法。

  6. 选择创建。

    创建自定义 API Governance规则

  7. 在 Created by your team下找到你的新规则并将 其打开 。

你还可以选择上传文件以上传有效 YAML 或 JSON 格式的新规则。

你不能创建复制现有规则的自定义规则。

打开和关闭配置的规则​

你可以为各种工作空间打开或关闭单独的 Governance 规则，以满足团队的开发需求。为此，请选择工作空间组。你可以通过选择创建组来创建一组新的工作空间以应用单独的管理规则，或者你可以选择一个现有的组来更新其管理配置。要将单独的监管规则应用于所有工作空间，请选择默认的所有工作空间组。

要为工作空间组打开或关闭监管规则，请选择一个现有组，然后选择编辑。要打开监管规则，请选中规则名称旁边的复选框。要关闭管理规则，请清除规则名称旁边的复选框。

打开和关闭个别规则

完成所需的更改后，选择Review Changes，然后选择 Apply Changes以保存它们。你的团队只会在你的 API 定义中看到违反已明确应用于其所在工作空间的 Governance 规则的情况。

从 API Governance 配置中删除规则​

删除图标 要删除 API Governance 规则，请在你团队的规则库中找到该规则，然后选择其名称旁边的删除图标 。你可以稍后选择 从规则库中重新导入它 。

如果你使用删除图标删除自定义规则 ，如果你想再次使用它，则需要使用 创建规则 删除图标将其 添加回 Postman 。