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 等那么正式，但检查一下可能会有用。