残りのAPIドキュメントの自動生成

Question

私は最近Rest APIドキュメントの受信を開始しました。私は実際にAPIの自動ドキュメント化に興味があります。

APIの標準メソッドのドキュメントを生成する自動ツールはありますか？私はいつもオープンソースのツールに興味がありますが、それが私のニーズに合っていれば、私は有料のソリューションにnoとは言いません。また、自動xmlドキュメントが含まれていれば巨大なプラスになります。

ドキュメンテーションを楽しく使いやすくするソリューションはありますか？

Answer 1

これを実行するための多くのオプションがあります。

"自己文書化RESTフレームワーク" をグーグルで

• Swagger
• Spring REST Docs
• RAML
• ApiDocJS
• ​​

います：This articleは、人気のオプションの数が少ないのリストを提供しますより多くのオプション。私は各オプションについていくつかの調査をすることをお勧めします。あなたのニーズに合ったものを見つけることができます。

Answer 2

Guzzleを使用している場合、PHP APIクライアントライブラリ、サービスドキュメントは本当にきれいです。

http://service-docs.adeslade.co.uk/

それはがつがつ食うが使用するのと同じJSON「サービスの説明」からコンパイルして、あなたが実際にAPIにリクエストを送信してから応答を受信することができることを意味するドキュメント用のHTMLに組み込まれてがつがつ食うクライアントが付属していますドキュメント自体の中にあります。

変更するたびに両方を更新するのではなく、Guzzのサービスの説明を最新の状態に保つだけで、ドキュメントは自動的に更新されます。

Answer 3

@tonicsoftは、いくつかの良いオプションを提供しています。さらに、「RESTful APIを文書化するための標準的な方法」に関する質問からの回答は、brief but helpful comments on the above options, plus a few moreを提供しています。