appidocドキュメント

nodejsをインストールします

# node -v //      nodejs

uuntuインストールnodejs

# sudo apt-get install nodejs  // node       nodejs

centosインストールnodejs

wget http://nodejs.org/dist/v0.10.24/node-v0.10.24.tar.gz

解圧ソース

# tar zxvf node-v0.10.24.tar.gz

コンパイル

cd node-v0.10.24
./configure --prefix=/usr/local/node/0.10.24
make
make install

NODE_の配置ホーム、profileに入って環境変数を編集します.

vim /etc/profile

nodejs環境変数を設定し、export PATH USER LOGNAME MAIL HOSTNAME HISTSIZE HISTCONTROLの一行に下記の内容を追加します.

    #set for nodejs
    export NODE_HOME=/usr/local/node/0.10.24
    export PATH=$NODE_HOME/bin:$PATH
    # :wq     ，  /etc/profile      
    # source /etc/profile

設定のインストールに成功したか確認します.

# node -v

アプリをインストールする
インストール

# npm install apidoc -g  //    npm            
# apt-get install npm

セットアップ

tips: npm       node    [     node  ]
/usr/local/nodejs/bin/npm install apidoc -g 

appidoc操作文法

# apidoc -i test/ -o test/apidoc/     //    

パラメータ

 -f, --                    .     .cs .dart .erl .go .java .js .php .py .rb .ts.
Example :
    apidoc -f ".*\\.js$" -f ".*\\.ts$"

-i, --           .
Example:
    apidoc -i myapp/

-o, --             .
Example:
    apidoc -o apidoc/

-t, --            .
Example:
    apidoc -t mytemplate/

以下の二つの例を比較して、appidocの文書パラメータについて基本的に認識します.
例1

/**
* @api {get} index.php?i=     
* @apiGroup test
* @apiVersion 0.0.1
* @apiDescription        
* @apiParam {String} token   token
* @apiParamExample     
* /index.php?i=8888
*  @apiSuccess {int} type    0：   1：  
* @apiExample       
* {
*    "status": "1",
*    "data": {
*               "first": 1,
*               "last": 3,
*    },
*    "msg": "    "
* } 
* @apiExample {json}       :
*     {"code":"0","msg":"    "}
*/

例02

/**
    * @api {POST} /test/:id    
    * @apiGroup test
    * @apiVersion 0.0.1
    * @apiDescription        
    * @apiParam  {String} name   
    * @apiParam  {String} [phone]   
    * @apiSuccess (Success) {String} msg   
    * @apiSuccess (Success) {int} code 0       1     
    * @apiError (Error) {String} msg   
    * @apiError (Error) {String} m   
    * @apiParamExample     
    * /index.php?i=8888
    * @apiSuccessExample {json}     
    *                {"code":"0","msg":"    "}
    * @apiErrorExample {json}       
    *                {"code":"0","msg":"    "}
*/

appidocドキュメントのパラメータの詳細

* @apiDeprecated [    ] //          []    {     }，         ，    ，       
* @api {POST} /test/:id     //            
* @apiGroup //  
* @apiVersion //  
* @apiDescription //  
* @apiParam  {String} name    //                        
* @apiParam  {String} [phone]    //             [phone]       
* @apiSuccess (Success) {String} msg    //            
* @apiError (Error) {String} msg    //            
* @apiParamExample       //  
* /index.php?i=8888        //  
* @apiSuccessExample {json}       //                 
*                {"code":"0","msg":"    "} //  json          ，apidoc           
* @apiErrorExample {json}        //                 
*                {"code":"0","msg":"    "}

tips
01:warn:Please create an appro.json configration file.

            apidoc.json  //     
{
  "name": "    ",
  "version": "0.1.0", //   
  "description": "apiDoc basic example", //   
  "title": "Custom apiDoc browser title", //   
  "url" : "http://192.168.197.135/"  //     
  "sampleUrl" : "http://192.168.197.135/"  //         
}

02:warn:parser plugin‘param’not found in block:1

                 
# rm -rf test/apidoc/*
# apidoc -i test/ -o test/apidoc/
--        ！

03:appidoc error:No files found.{Path:'/data/wroot'}

      nodejs        npn