RPC API文档工具

Question

RPC API文档工具

jsonapirpcdocumentation-generationamqp

15

有许多优秀的工具可用于源代码和API文档（例如doxygen、Headerdoc、Sphinx等），但是它们似乎都不擅长为通过RPC接口提供的API生成文档（如果您有关于如何使用这些工具综合RPC API文档的建议，请尽管提出）。

我特别感兴趣的是至少在某种程度上支持JSON和AMQP的文档工具，但这个问题也适用于Protobuf、Thrift、XML-RPC等技术，任何与这些技术配合的工具建议至少可以给我一个起点。

老实说，我还没有看到过任何RPC接口的高质量文档（无论是手动编写还是使用工具），希望这只是因为开发人员懒惰而不是因为这些工具不存在。

- Nick Bastin

类似的问题？https://dev59.com/12025IYBdhLWcg3wChOc - Pranalee

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- steve · Accepted Answer

看一下Swagger（http://swagger.wordnik.com）- 这是我们在3scale（http://www.3scale.net）中用于所有API的工具。基本上，它将采用JSON规范并执行各种操作，包括为您创建交互式API文档。RPC样式文档应该没问题（我们修改了它以接收/发送XML）。还有用于从各种语言的代码生成规范的工具。

最后，还有一个简单的代码提取器工具，可以创建JSON：https://github.com/solso/source2swagger。所有这些都比Doxygen等更不正式，但可能值得一试。