首页 > 解决方案 > 我们可以检查 OpenAPI 规范文件是否与编写的代码同步?

问题描述

我有一些想要启用 OpenAPI(以前称为 Swagger)规范文件检查的存储库。有一些工具(即Stoplite 的 Spectral)可用于验证为 Yaml 文件提供 lint 支持的文件。

但是,我想要实现的是,如果我在代码中编写 API(即 GO 或 Java 或 Python)并且如果我没有在 OpenAPI Spec 文件中指定该 API,那么它应该在 CI 工具中引发错误。

如果我们可以检查协议缓冲区和 OpenAPI 规范文件之间的同步,那么它也会很有用,所以请务必提及是否有可用的工具。

我相信我们可能需要针对不同语言的不同工具,这是可以的,但我们是否有任何语言的工具,我不确定。

标签: continuous-integrationswaggerprotocol-buffersopenapiproto

解决方案


推荐阅读