RPC API的文档工具
RPC API的文档工具
提问于 2011-01-30 09:10:06
有很多很好的工具可以用来编写源代码和应用程序接口文档(doxygen、Headerdoc、Sphinx等等)。但是，它们似乎都不是特别擅长为通过RPC接口提供的API生成文档(如果您有关于如何使用这些工具合成RPC API文档的建议，请务必推荐)。
我对文档工具特别感兴趣，这些工具至少支持JSON和AMQP，但这个问题也代表Protobuf、Thrift和XML-RPC之类的东西，任何使用这些技术的工具建议至少会给我一个起点。
老实说，我还没有看到任何RPC接口的高质量文档(无论是手工生成的还是通过工具生成的)，我只是希望这是因为开发人员懒惰，而不是因为工具不存在。
回答 1
Stack Overflow用户
发布于 2012-06-12 23:03:45
看看Swagger (http://swagger.wordnik.com) -这是我们在3scale (http://www.3scale.net)上使用的所有apis。基本上，它将采用JSON规范并执行各种操作，包括为您创建交互式API文档。RPC样式的文档应该没问题(我们对其进行了修改，以获取/接收XML)。还有一些工具可以从各种语言的代码中生成规范。
最后，有一个简单的代码提取工具，可以创建JSON：https://github.com/solso/source2swagger。所有这些都比Doxygen等不那么正式，但可能对检查很有用。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/4840536
复制相关文章
相似问题
腾讯云开发者
