python - 如何自动生成nameko微服务的rpc接口文档？

Question

我看到一些关于 nameko RESTful 微服务 + swagger的例子，它们可以生成惊人的接口文档。但是，就我而言，我只使用 RPC 而不是 HTTP。是否有任何类似 swagger 的库来记录 RPC 接口？

Answer 1

不幸的是，目前还没有类似工具可以用来记录 Nameko 的 RPC 接口。

由于 Nameko 的 RPC 实现是基于 AMQP 的，因此您很可能同时控制客户端和服务器端，在这种情况下sphinx-doc，您可以使用常规的 Python 文档工具。

如果您想向外部客户端公开 API 并与他们共享服务定义，您可以查看 Nameko 的 GRPC 实现https://github.com/nameko/nameko-grpc（以及示例：https ://github.com /nameko/nameko-examples-grpc）。

gRPC 基于 Protocol Buffers 服务定义，这些定义有效地记录了您的 API 接口，并可用于生成客户端库。