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 等形式化，但可能对检查有用。