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）のすべてのapisに使用しています。基本的には、JSON仕様を採用し、インタラクティブなAPIドキュメントを作成するなど、さまざまなことを行います。 RPCスタイルのドキュメントはうまくいくはずです（私たちはXMLを受け取り/受け取るために改訂しました）。また、さまざまな言語のコードから仕様を生成するためのツールもあります。

最後に、JSON：https://github.com/solso/source2swaggerを作成できる簡単なコード抽出ツールがあります。このすべてはDoxygenなどよりも形式化されていませんが、チェックアウトするのに役立つかもしれません。