アプリケーション自動生成インターフェースドキュメント

最近の整理項目では、インターフェースの文書がばらばらで、まだ正確ではないことが分かりました.appidocはコメントに基づいてapiドキュメントを自動的に生成します.ここで記録してください.
インストール手順:

appidocは、nodejsベースのAPI文書生成ツールであり、先にシステムがnodejsをインストールしているか確認してからappidocをインストールし、実行:npm install -g apidoc

配置appidoc、あなたのプロジェクトのルートディレクトリの下でappidoc.jsonファイルを作成して、appidoc.jsonは

を説明します.

{
  "name": "api doc",
  "version": "0.1.0",
  "description": "interface doc",
  "title": "    ",
  "url" : "http://localhost:8080"
}

3.対応するインターフェースの方法にコメントを追加します.

/**
 * @api {POST} /register     
 * @apiGroup Users
 * @apiVersion 0.0.1
 * @apiDescription       
 * @apiParam {String} account       
 * @apiParam {String} password   
 * @apiParam {String} mobile    
 * @apiParam {int} vip = 0      Vip   0      1 Vip  
 * @apiParam {String} [recommend]    
 * @apiParamExample {json}     ：
 *                ?account=sodlinken&password=11223344&mobile=13739554137&vip=0&recommend=
 * @apiSuccess (200) {String} msg   
 * @apiSuccess (200) {int} code 0       1     
 * @apiSuccessExample {json}     :
 *                {"code":"0","msg":"    "}
 */

注記の意味は、appidoc公式文書@appiがAPIの要求方法、経路、名前を定義することを参照してください.そうでなければ、appidocコンパイラはこの注釈を無視します.@app Group定義APIのパケット@apper Versionバージョン@appie Description定義APIの記述@apple定義APIのパラメータ@apper Exampleパラメータ要求の事例@apper Example APIエラー例@appech Example API正常例@
注:@app Groupはutf-8文字列に対応していません.asciiコードのみ対応します.英語しか使えません.中国語を使いたいなら、次のコードを使います.

/**
 * @apiDefine user        
 */
/**
 * @api {post} /user
 * @apiGroup user
*/

説明1、@appie Defineは/*…/の中に置かなければならないし、参照変数のところからも分離しなければなりません.2、@app Groupの後に置くのは@appDefine定義の変数名です.
4.文書作成命令apidoc -i com/ -o apidoc/-i com/は、comフォルダの下にあるappoc構文注釈のコードを全部作成した文書-o appidoc/は、文書の作成ディレクトリの実行が完了したら、appocフォルダの下のindex.ファイルを開いて、対応するapiドキュメントを見ることができます.
参考:http://apidocjs.com/https://cloud.tencent.com/developer/article/1005271 https://blog.csdn.net/soslinken/article/details/50468896