アプリ自動生成インターフェースドキュメント(windows)

1772 ワード

1、nodejsをインストールして、https://nodejs.org/en/download/nodejsをダウンロードして、ふだんのソフトウェアの流れによって一歩ずつインストールしてきます.
2、apidocをインストールし、window shellコマンドラインにnpm install apidoc -g を入力する.3、  
パラメータ
説明
-f
解析するファイルを選択し、正規表現をサポートします.fパラメータは複数回使用できます.複数の表現は異なる−fに対応します.apidoc -f ".*\.js$" -f ".*\\.ts$"-i
ソースコードの位置を選択します.apidoc -i myapp/-o
生成したターゲットファイルの場所を選択します.apidoc -o apidoc/-t
ファイルを生成するためにテンプレートを選択して、ユーザー定義のテンプレートを作成して使用することができます.(筆者の注:今まで、筆者はこのパラメータを使ったことがありません)
-h
ほとんどのコマンドと同じように、このパラメータはヘルプドキュメントを印刷できます.4、 :PHP ( ):
/**
     * @api {get} /api/goods/info     
     * @apiDescription      
     * @apiGroup GOODS
     * @apiParam {int} goods_id   id
     * @apiSuccessExample {json} Success-Response:
     * {
     * "code": "10000000",
     * "data": {
     * "id": 22,//  id
     * "title": "1121231231231231331", //    
     * "price": "6000.00",//  
     * "img": "1321132321",//    
     * "img_list": "",
     * "desc": "123312",//  
     * "is_sale": 1,
     * "created_at": null,
     * "updated_at": null
     * },
     * "msg": "  "
     * }
     */
    public function info(){
        $goodsId = $this->body['goods_id'];

        $goodsService = new GoodsService();
        $result = $goodsService->getGoodsInfo($goodsId);

        return $this->returnJson(['code'=>'10000000','data'=>$result]);
    }
4、実行コマンドapidoc -i server/ -o apidoc/  (src/ PHP ,apidoc/ )