生成gRPC API文档的方法（专门针对Java、Spring Boot）

Question

我想在我的 Spring Boot 应用程序中记录 gRPC API。我浏览过的网络资源建议将端点映射到 REST，然后生成文档（例如 Swagger）。我想知道是否有一种更简单的方法（无需 REST）来记录 gRPC 端点（例如 Swagger），以便在发生某些更改时能够“自动”生成文档。

Answer 1

不确定这是否是您想要的，但是您可以使用Sabledocs为Protobuf和gRPC合约生成文档，但它与Java或SpringBoot没有直接连接，它纯粹基于合约工作。

您可以通过生成 Protobuf 文件的二进制描述符来使用它：

protoc *.proto -o descriptor.pb --include_source_info

安装

sabledocs

CLI。 （需要 Python >=3.11）

pip install sabledocs

并运行

sabledocs

命令。

sabledocs

文档将生成到文件夹

sabledocs_output

中，可以通过

index.html

打开其主页。

您可以在此处查看生成的文档站点的演示，并在存储库和这篇博客文章中找到更多信息。