ディレクトリ
インタフェース仕様書管理慣行は、コンポーネントが連携増加に寄与：グローバルプロジェクト管理の観点のインターフェースについては、開発効率（例えば前面および分離の後端として）、とも容易に放出を達成することができます。
ドキュメント管理を改善し、文書フォーマットは説明として、文書管理の2つの部分が含まれている必要があります。
APIドキュメント・フォーマット
API仕様書の形式は、大幅に開発効率を向上させることができ、理解し、不要な通信コストを削減することができます。
しかし、統一フォーマットの制約を（別のプロジェクトのすべての不合理な要求事項の後に、別の建築家が異なるスタイルを持っている）を採用する必要はない、Wordで書かれたような一部の人は、何人かの人々は、趣味のマークダウン構文を選択しました。要するに、関係なく、採用フォーマットの、APIインタフェースはフルにする必要があり、明確な記述（例：インターフェース機能、メソッド定義、パラメータの意味、フォーマット、およびそう返されました）。
チームは統一APIドキュメントフォーマット仕様を持っていない場合は、参照がよいアリゴールドのドレスのドキュメントフォーマットのAPIデモデザイン。
ドキュメント管理
RESTfulなAPIドキュメント管理（生成、保守）は大きく3つのカテゴリに分けることができます。
注釈ベースの実装、一緒にコードとドキュメント
注釈文書のメリットに基づくだけでは、ドキュメントを維持していない、一緒にコードとドキュメントを生成し、欠点が明らかにされている、文書が、それはコードは非常に厄介に見えるようになります事業のコードを埋め込む必要性を指摘しています。
注釈法に基づく典型的な実装ドキュメント管理ツールは、以下のとおりです。闊歩、Api2Doc。
濶歩
闊歩は非常に人気のRESTfulなドキュメント生成ツールですが、比較的標準化と完全なドキュメントを生成する必要がある場合は、あまりにも多くのメモを書くために、それは面倒です、以下を参照してください。https://swagger.io/を。
文書管理を実現するためのインタフェースの使用上の闊歩は、次のリソースを参照することができます。
https://github.com/swagger-api闊歩GitHubのプロジェクトの公式サイト
https://www.jianshu.com/p/33c28a65deb8 Swagger-強力なAPIドキュメントツール
HTTPS ：//blog.csdn.net/zhangxin09/article/details/82699353闊歩2（オープンAPIのV3.0）Javaドキュメントのガイドラインを生成するために（上）
https://www.ibm.com/developerworks/cn/java/j- -闊歩・イン・A-使用して 、ばねブートプロジェクトを/ index.htmlの春ブーツプロジェクトで闊歩文書を使用
https://blog.csdn.net/u014745069/article/details/80246803闊歩使用インターフェイスパラメータ----欠陥を使用して注釈付き
https://blog.csdn.net/xiaojin21cen/article/details/78654652ノートをswagger2説明
https://blog.csdn.net/cy921107/article/details/82761575 Swagger2 JSONObject上のパラメータは、APIドキュメントで説明し、詳細なパラメータとパラメータを示し
http://www.voidcn.com/article/p-bxgydblc-bnz.htmlを闊歩を使用する方法前後端を隔てる障壁をなくしますか？
https://www.cnblogs.com/softidea/p/6226463.html闊歩トピック
https://www.cnblogs.com/ceshi2016/p/10511959.html闊歩注釈コメント（推奨コレクション）
Api2Doc
Api2Docの闊歩と同様の原理が、春ブートフレームワークに基づきます。
現在、このツールは、完璧ではない統合された1.0.2バージョンを与えられて、次を参照してください。
https://github.com/terran4j/commons/tree/master/commons-api2docの api2doc公式サイト
APIベースのテスト生成ツール
コードとドキュメントの分離が、別のドキュメントを記述することなく、文書がインターフェイステストで発生させることができます。
郵便配達
あなたはプライバシーの権利を検討する必要があり、適切でない可能性がある場合、APIドキュメントのための出版社の要求をサポートするためのポストマンは、オンラインで閲覧することができます。
http://book.crifan.com/books/api_tool_postman/website/postman_api_doc/preview_publish_api_doc.html APIドキュメントをプレビューして公開
残りのクライアント
郵便配達のオープンソースのAPIドキュメントに似残り、クライアントの個人的なREST APIテストツールは、Java SwingベースのGUIインターフェイスで書かれ、APIによると、直接オフに生成することができます。
https://github.com/Wisdom-Projects/rest-client
独立した書き込みのドキュメント
独立したメンテナンスのAPIドキュメントは、最も簡単な方法ですが、欠点も明らかであり、それは時刻同期コードとドキュメントには、おそらくではなく、それも文書が古くなっている可能性があります。
のフォーマット（たとえば、あなたが書き込みのためExecelテーブル、マークダウン構文を使用することができ、さらにワード）：あなたは別のAPIドキュメントフォーマットを書くのが好き何でも使用することができ、オンラインのニーズに応じて設計することができ、オフライン（現在はない不足多くのオンラインAPI管理システムはありません）。
ここではいくつかの一般的なWebベースのAPI管理ツールが簡単だったされています。
RAP
公式サイト：https://github.com/thx/RAP
RAPアリオープンソースのWebインターフェース管理ツール、オープンソース、無料、サポートオートメーションインターフェイス、MOCKデータ生成、テストの自動化、エンタープライズクラスの管理。
RAPの機能の比較が、しかし、JSON形式、悪い評価でのリクエストパラメータをサポートしていません。
DOClever
：DOClevenのAPIは、業務管理システム、公式ウェブサイトであるhttp://doclever.cn/controller/index/index.html。
オープンソース版は参照してくださいあり：https://github.com/sx1989827/DOClever。
DOCleverは非常に強力かつ包括的なとして知られているが、それはですが、カットのオープンソース版はそれを行うことができ、二次開発に基づいて、直接使用することを引き継ぐのに適していない、あまりにも簡単でした。
インストールがNPMのオープンソース版を使用しないことをお勧めされている場合は、ソースのインストールを使用して起動したとき、さまざまなエラーをインストールし、この問題はありません。
# 在安装DOClever之前先安装并启动MongoDB
# 使用源码方式安装DOClevere
$ git clone https://github.com/sx1989827/DOClever.git
$ cd DOClevere
$ npm start起動エラー場合は、ノードのバージョン8.11.1を使用することをお勧めします。
APIDOC
：独立して作成されたAPIドキュメントのためのもう一つのツールがAPIDOC、公式ウェブサイトであるhttp://apidocjs.com。
共通のインタフェース文書管理ツールに関しては、APIDOCは奇妙な方法の明確な比較を取ります。これは、インターフェイスを介してである（注：このインタフェースは、ビジネス・インターフェースではなく、世代のドキュメントをインタフェースすることを意図している）APIを定義し、基本的にビジネスコード外の保守インタフェースの文書です。
https://blog.csdn.net/soslinken/article/details/50468896使用apidoc RESTfulなWeb APIドキュメントを生成
https://blog.csdn.net/qq_27384769/article/details/78622831の apidocチュートリアル-素敵なAPIドキュメントを書きます
CrapApi
CrapApiは、オープンソース製品が最も満足し、基本的な文書管理APIは、より包括的であるが、支援のための模擬試験はまだ比較的弱いです。
しかし、長所と短所は、オープンソースのシステムのために、コア機能は、推奨、かなり良いされている参照：https://gitee.com/CrapApi/CrapApiを。
CrapApiのインストールでは、Tomcatのwebappsディレクトリにちょうど戦争のパッケージにアクセスできるように、従来のJava Webプロジェクト、最終包装の規格争いのファイルであり、これ自体は、非常に簡単です。
SQLスクリプトのCrapApiのソースコードが導出されているので（主に形式でノートツール、使用して：それは注目に値する/***/いくつかのSQLツールでコメントする）エラーの可能性があり、それを削除します。
最後に書かれました
文書管理のためのAPI、さまざまな方法が、完璧で、確かにないプログラム、それぞれが独自の長所と短所があり、主に：
1.コードで文書を維持する、それは、Javaでのアノテーションを介して行うことができますほとんどのコードとドキュメントの一貫性を維持することを助長するが、真のビジネスコード、多分不良の性能低下のシンプルさを汚染しますノートの束を、追加するために比較的よく文書化の必要性を生成するために、
2別々の書かれた文書道のビジネスコードを汚染しますが、原因コードとドキュメントの完全な分離に、コードとドキュメントの一貫性を維持するためのコストを増大させることが目に見えないだろうではないが、
対照的に3、文書の生成はベースより折衷APIテストツールの道が、結果自体は非常に強く結合する文書の機能とツールは、民営化と権限管理を導入することは困難です。
確かに、いずれかの方法は、文書のメンテナンスは、タイムリーな更新を確保するために、いくつかのハードと高速のルールや規制が必要です。開発者の悪い習慣かどうかが必須の規定の場合、（例えば闊歩など）方法：でも、コード内のメンテナンスに関するマニュアルで、開発者のための共通の問題である「プログラマは、文書を書くことが好きですが、他の誰かがドキュメントを書きたくありません」開発者はタイムリーなメンテナンスが文書を更新し、文書がまだ結局、これは人々が駆動するために必要である、コードの同期で問題が解決しない（パラメータを変更増加し、この方法は、対応する文書のノートを注入する必要があります）。
だから、APIドキュメントのメンテナンスのためにかかわらず、使用する施行の対応するシステム、あるいは最適なツールを持っている必要があり、メンテナンスモードを使用して文書のさらに悪い意味ではない、普遍的な解決策ではありません。することができ、適切なプログラムを選択するには、結局のところ、どんな手段だけではない：文書管理の種類、建築家の好みに応じて、またはプロジェクト自体（外部リリースおよびその他の要因の必要性などのように）の実際のニーズに応じての選択について自分の目標を達成するためのツールは、キーを効率的に使用する方法です。
【参考】
https://www.jianshu.com/p/be32a38f408d道路のAPIインタフェース管理
https://blog.csdn.net/vimx86/article/details/78381838インタフェースの文書管理ソリューション
https://hacpai.com/ Articleこの記事だった/ 1519833837647 APIおよび管理ツールは、RAPの比較を闊歩
https://www.cnblogs.com/minsons/p/7133095.htmlのAPI管理ツール（春-残り-ドキュメント）の