跳到主要内容

验证接口(Validating APIs )

你可以在 Postman 中编写 API 定义时对其进行验证。这有助于保持你的 API 定义明确。如果定义中存在语法错误,Postman 将列出已发现的问题以及针对这些问题的修复。

验证 API 定义

API 定义验证可用于 OpenAPI 2.0、3.0 和 3.1 以及 WSDL 1.1 和 2.0 定义。

Postman 在你 编辑 API 定义时指出 API 定义 中的验证语法错误。错误可能包括缺少必填字段、格式错误的字段名称、不正确的数据类型、不正确的嵌套或其他 API 定义验证问题。

API 定义编辑区域下方的窗格显示问题。你可以在工作时隐藏和显示错误视图。

每个错误都将指出类型、发生错误的行以及问题的详细信息。要在键入时获取更多信息,你还可以将鼠标悬停在编辑器中的内联错误上。

API定义错误

请注意,有时定义中的一个错误会导致列表中出现多个问题。当你修复错误时,验证问题就会消失。

如果你定义的 JSON 或 YAML 语法有问题,Postman 将显示警告。查找编辑器中指示的错误并将鼠标悬停在它们上方以获取更多详细信息。为了使 Postman 能够验证你的定义元素,JSON 或 YAML 必须格式正确。

如果没有错误,Postman 将在下方窗格中指示你的 API 定义是有效的。

验证元素

Postman v10 不再支持将 API 定义与文档和测试集合进行比较以确定元素是否需要更改以保持同步的能力。如果你一直在使用此功能,可以在 社区论坛 上提供反馈。