验证 API
您可以在 Postman 中验证您的 API 架构,并根据您的架构验证您的元素(文档、测试、模拟服务器和监视器)。这有助于保持您的 API 定义良好,并确保您的元素与您的架构同步。如果架构上存在验证错误或元素不匹配,Postman 将提供已发现的问题列表以及这些问题的修复。然后,您可以对 API 元素应用修复并重新验证它们。
验证模式
模式验证可用于 OpenAPI 2.0、3.0 和 3.1 以及 WSDL 1.1 和 2.0 模式。
当您在 API 版本页面的定义选项卡中编辑 API 架构时,Postman 会指出验证错误。错误可能包括缺少必填字段、格式错误的字段名称、不正确的数据类型、不正确的嵌套或其他 API 架构验证问题。
架构编辑区域下方的窗格显示问题。您可以在工作时隐藏和显示错误视图。
每个错误都将指明类型、发生错误的行以及问题的详细信息。您还可以将鼠标悬停在编辑器中的内联错误上,以在您键入时查看信息。
请注意,有时架构中的一个错误会导致列表中出现多个问题。当您修复错误时,您将看到验证问题消失。
如果您的模式 JSON 或 YAML 语法存在问题,您将看到一条警告。查找编辑器中指示的错误并将鼠标悬停在它们上以获取更多详细信息。只有当 JSON 或 YAML 本身格式正确时,Postman 才能验证您的架构元素。
如果没有错误,Postman 将在下部窗格中指示您的架构是有效的。
验证元素
元素验证可用于 OpenAPI 3.0 和 WSDL 1.1 和 2.0 模式。
您可以将您的 API 模式与相关的文档、模拟服务器、测试和监视器进行比较,以确定元素是否需要更改以保持同步。例如,如果您向 API 架构添加新方法,验证将指示您需要将该方法添加到相关文档中。或者,当您向 API 添加新元素时,您可以运行验证以根据当前 API 模式检查元素是否存在问题。
每个元素在其位于 API 页面中的位置旁边都有一个验证列。(文档和模拟服务器位于 API概述选项卡上;测试位于测试选项卡上;监视器位于监视器选项卡上。)
要验证新元素,请在元素旁边的验证列中选择验证。要重新验证元素,请选择状态,然后选择Validate Again。
验证完成后,如果未发现任何问题,则元素旁边会出现一个复选标记,或者会显示一条警告消息,指出发现了问题。如果有问题,请选择状态,然后选择查看问题以查看它们。
验证请求
如果您希望验证您的请求,您的集合必须链接到 API。
如果您从模式生成集合或将其作为与现有 API 的关系添加,则集合将链接到 API。
Postman 将在发送请求时对其进行验证。如果发现问题,您将看到一条警告消息,显示请求名称旁边的问题数量。
验证是特定于版本的,并且将针对与集合链接的 API 的特定版本的架构执行。如果集合的一个版本链接到多个 API 版本,Postman 将从最新创建的 API 版本中选择模式进行验证。
访问问题
您可以查看在验证期间发现的问题,以修复您的集合或架构中的问题。
如果在运行请求时出现问题,请选择请求名称旁边的警告消息(例如1 issue)。这将在右侧打开一个面板,指示有关请求的哪个组件受到影响以及问题本身的详细信息,以及指向验证请求所依据的 API 的直接链接。选择链接以在 Postman 中打开 API。
您可以选择特定问题来访问相关请求组件。
如果您的问题与其他元素有关,请通过在应用侧边栏中选择API导航到您的 API ,然后从列表中选择 API 版本。打开包含您要查看问题的元素的选项卡(Overview、Test或Monitoring)。
您将在元素旁边看到一个状态,指示在验证期间是否发现了问题。如果有问题,请通过选择Issues found > View issues来查看它们。这将带您进入总结验证问题的页面。
更新 API 元素
问题摘要指示每个问题的详细信息,并提供可以自动应用于相应 API 元素的修复。
了解问题摘要
验证摘要列出了在生成的集合和 API 模式之间发现的所有问题。您可以选择对集合进行的建议更改。
您可以在右侧栏中选择请求名称或请求元素以直接导航到相应的问题。
审查包含有关需要进行哪些更改才能使 API 元素再次与架构同步的详细信息。
将更改应用于 API 元素
您可以在查看更改时单独选择要应用于 API 元素的更改。导航到您要应用的更改并选中它旁边的复选框。对您要应用的每个更改重复相同的操作。
完成选择要应用的更改后,选择Confirm Changes to Collection。
或者,您可以通过选择Select all changes,然后Confirm Changes to Collection来应用所有更改。
您可以通过从确认屏幕中选择查看更新的集合来访问更新的 API 元素。如果您没有应用所有更改,您还可以通过选择查看剩余问题来查看剩余问题。
如果您一直在使用此功能,Postman 团队希望收到您的来信!您可以在社区论坛上提供反馈。
下一步
除了使您的 API 元素与架构保持同步之外,您还可以分析和利用报告来促进对 API 执行方式的了解。