apidoc自动生成接口文档（windows）

1、安装nodejs,到https://nodejs.org/en/download/ ，下载nodejs，按照平时软件流程一步步安装下来

2、安装nodejs，在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/是生成文档所在位置）

apidoc自动生成接口文档（windows）

猜你喜欢