如何自动生成nameko微服务的rpc接口文件?

How to auto-generate documents of rpc interface of nameko microservice?

我看到了一些关于nameko RESTful微服务+swagger的例子,可以生成非常棒的接口文档。但是,就我而言,我只使用 RPC 而不是 HTTP。是否有任何类似 swagger 的库来记录 RPC 接口?

不幸的是,目前没有类似 swagger 的工具来记录 Nameko 的 RPC 接口。

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

如果您想向外部客户公开 API 并与他们共享服务定义,您可以查看 Nameko 的 GRPC 实现 https://github.com/nameko/nameko-grpc (and examples: https://github.com/nameko/nameko-examples-grpc)。

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