跳到主要内容

规则冲突（Rule violations）

在创建 API 定义时遵循 Postman API Governance 和 API 安全规则可帮助你创建一致且安全的 API。当你的 API 定义违反其中一条规则时，并不意味着该定义已被破坏。相反，它表示你的 API 可能存在潜在的安全风险，或者可能影响其可用性的潜在设计问题。Postman 会突出显示这些违反规则的行为，并帮助你了解它们的影响以及解决这些问题的可能方法。 Postman support OpenAPI 3.0 和 OpenAPI 2.0 格式的 API 定义的 API Governance 和 API 安全规则。

规则定制。 企业团队 还可以自定义 Postman 应用于 API 定义的规则。有关详细信息，请参阅 配置 API Governance 规则 和 配置 API 安全规则 。

OpenAPI 3.0 规则违规

查看 API 定义中的 Governance 和安全规则违规​

  1. 在边栏中选择API，然后选择你要查看的 API。

  2. 在 API 概述页面中，选择定义部分中的查看文件。

    你也可以在侧边栏中选择API，然后直接选择 API 定义文件。

  3. 选择规则以查看违反规则的列表。

要详细了解规则违规如何帮助你创建一致且安全的 API 定义，请参阅 查看 API 定义中的规则违规 。

跟踪 CI/CD 中的 Governance 和安全规则违规​

此功能在 Postman Enterprise 计划中可用。

你可以配置 CI/CD 管道，以在 Postman CLI 的帮助下强制执行为你的团队配置的 API Governance 和 API 安全 规则。

在 Postman CLI 配置页面上，选择Run Governance and Security rules。这将生成 Postman CLI 配置。你可以在 CI/CD 配置中使用它来在每次 CI/CD 管道运行时强制执行 API Governance 和 API 安全规则。

生成 Postman CLI 配置

要查看结果，请转到构建运行页面并使用箭头展开所需的构建。接下来，展开 API 定义以查看构建结果和任何违反规则的情况（如果适用）。

下一步​

有关 Postman 在开发的 API 定义阶段可能显示的所有违反规则的列表，请参阅 OpenAPI 3.0 规则 和 OpenAPI 2.0 规则 。