如何自動生成nameko微服務的rpc接口文檔？

Question

我看到一些關於 nameko RESTful 微服務 + swagger 的例子，它們可以生成令人驚嘆的接口文檔。 但是，就我而言，我只使用 RPC 而不是 HTTP。 是否有任何類似 swagger 的庫來記錄 RPC 接口？

Answer 1

不幸的是，目前沒有用於記錄 Nameko 的 RPC 接口的工具。

由於 Nameko 的 RPC 實現是基於 AMQP 的，因此您很可能會同時控制客戶端和服務器端，在這種情況下，可以使用常規 Python 文檔工具，例如sphinx-doc 。

如果您想向外部客戶端公開 API 並與他們共享服務定義，您可以查看 Nameko 的 GRPC 實現https://github.com/nameko/nameko-grpc （和示例： https : //github.com /nameko/nameko-examples-grpc ）。

gRPC 基於 Protocol Buffers 服務定義，它有效地記錄了您的 API 接口並可用於生成客戶端庫。