RPC API的文档工具

Question

源代码和API文档有很多好的工具（doxygen，Headerdoc，Sphinx，仅举几例。但是，它们都不是特别擅长为通过RPC接口提供的API生成文档（如果您有关于如何使用这些工具合成RPC API文档的建议，请务必建议）。

我特别感兴趣的文档工具至少支持JSON和AMQP，但问题也适用于Protobuf，Thrift等问题，和XML-RPC以及与这些技术一起使用的任何工具建议至少可以为我提供一个起点。

老实说，我还没有看到任何RPC接口的质量文档（通过手工或工具生成），我只是希望这是因为开发人员很懒，而不是因为工具不存在。

Answer 1

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

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