验证 OpenAPI YAML 源
如何在编辑 API 时根据 Swagger 规范验证 OpenAPI YAML 源。
关于此任务
在 API 编辑器中配置 API 时,可以通过单击 来验证 OpenAPI YAML 源。 如果找到任何 Swagger 解析器验证错误,那么将显示一个错误图标,您可以单击该图标以查看各个错误以及这些错误在 YAML 中的发生位置。 然后,您可以修正错误,保存更新,并在整个 API 配置过程中继续验证 OpenAPI YAML。
注:
- OpenAPI 验证不会显示将阻止 API 登台或发布的网关或策略错误。 仅当您尝试编译打包或发布 API 时,才会发生此类型的验证。 有关更多信息,请参阅 登台 API 或 发布 API。
- 您还可以使用 Governance 规则集来验证 API 文档。 有关更多信息,请参阅 使用监管服务验证 API 或产品文档。
您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。
过程
要验证 OpenAPI YAML 源,请完成以下步骤。
- 打开所需的 API 以进行编辑,如 编辑 OpenAPI 2.0 API 定义 或 编辑 OpenAPI 3.0 API 定义中所述。
- 从标题中的菜单栏单击 。

- 如果发现任何 Swagger 解析器验证错误,那么将在标题菜单栏上显示一个错误图标,找到的 OpenAPI 错误数显示在该图标旁边。 例如,
。 - 然后,您可以单击错误图标以查看错误及其在 YAML 中的位置的详细列表。 如果您位于 " 表单
" 视图中,那么可以单击单个错误以直接浏览到表单中的相关 API 部分。 - 修正错误后,单击 保存 以保存更新,然后再次单击 验证 。
- 修复所有错误后,验证将返回一条成功消息。 例如,
。