Как автоматически сгенерировать документы интерфейса rpc микросервиса nameko?

Question

Я вижу несколько примеров о nameko RESTful microservice + swagger , который может генерировать удивительный интерфейсный документ. Однако в моем случае я использую только RPC, а не HTTP. Есть ли какая-нибудь чванливая библиотека для документирования интерфейса RPC?

Answer 1

К сожалению, в настоящее время не существует подобного инструменту для документирования RPC-интерфейса Nameko.

Поскольку реализация Nameko RPC основана на AMQP, вы, скорее всего, будете управлять как клиентской, так и серверной стороной, и в этом случае вам будут доступны обычные инструменты документации Python, такие как sphinx-doc.

Если вы хотите предоставить API внешним клиентам и поделиться с ними определением службы, вы можете взглянуть на реализацию GRPC Nameko https://github.com/nameko/nameko-grpc (и примеры: https://github.com/nameko/nameko-examples-grpc).

gRPC основан на определениях службы буферов протокола, которые эффективно документируют ваш интерфейс API и могут использоваться для создания клиентских библиотек.