如何从protobuf文件生成OpenAPI 3文档

时间:2020-02-25 23:31:57

标签: protocol-buffers openapi

我有一个由protobuf生成的API,我想生成符合OpenAPI 3规范的文档。我查看了许多实用程序,但没有找到一种有效的组合。

有人知道我可以遵循的从protobuf到OpenAPI 3的路径吗?

3 个答案:

答案 0 :(得分:1)

Google在GitHub上有一个repository可以做到这一点。它包含OpenAPI v3(和v2)的示例,显示了等效的protobuf代码的外观。

这里是medium article,它逐步介绍了端到端gRPC + HTTP(分别使用protobuf和swagger)服务器实现和文档。这是一个OpenAPI v2示例,但是类似的概念也适用于OpenAPI v3。

还有其他repositories可以执行相同的操作,但是我建议使用实际上来自源代码的源代码。 :)

希望这会有所帮助!

答案 1 :(得分:1)

我最近搜索了答案,找到了这个包: protobuf2swagger 它可以在需要 js 配置文件的 CLI 中运行。这个打包解决了我的问题。

答案 2 :(得分:0)

您正在寻找gnostic中的 protoc-gen-openapi应用。但它似乎被遗弃并且无法正常工作。

不知道它是否有效。