安装npm 卸载npm 安装apidoc

npm: Nodejs下的包管理器。
1.安装npm：在node.js官网https://nodejs.org/en/下载node.js并安装

2.判断是否安装完成，命令行输入 npm-v

3.若提示npm命令不存在，则将根目录下得node_modules添加到系统环境变量，重试。
4.卸载npm;首先删除安装目录，然后删除系统目录的npm目录，最后在控制面板中卸载node.js.

5.安装apidoc 官网文档apidocjs.com/
安装命令：npm install apidoc -g
项目根目录新增apidoc.json配置如下：（具体参数配置查看官网）

新建一个根目录存放生成的文档信息且在controller中配置：（具体参数配置查看官网）
/**

• @api {post} /supplier/Info/updateSupplierInfo 更改供应商信息
  • @apiName updateSupplierInfo
• @apiGroup Supplier
• • @apiParam {int} supplier_code 供应商编码
  • @apiParam {string} name 供应商名称
  • @apiParam {string} en_name 供应商英文名称
  • @apiParam {string} en_name 供应商英文名称
  • @apiParam {string} short_name 供应商 ID（简称）
  • @apiParam {float} reg_capital 注册资本
  • @apiParam {string} product_country 主营产品和国家
  • @apiParam {string} first_product 初次询价商品
  • @apiParam {date} build_at 成立时间
  • @apiParam {int} province_id 省id
• @apiParam {string} province_name 省份名
  • @apiParam {int} city_id 城市id
• @apiParam {string} city_name 城市名
  • @apiParam {string} collaboration 合作建议
  • @apiParam {string} brand_productivity 合作品牌和产量
  • @apiParam {string} coordinate 配合度
  • @apiParam {json} contact_person 联系人，数组，每个元素包含姓名name，电话phone,邮箱email，是否主要联系人is_base字段
  • @apiParam {json} qua_files 资质文件，数组，每个元素包含name，file_type和path字段
  • @apiParam {json} other_files 其他文件，数组，每个元素包含name，file_type和path字段
  • @apiParam {string} account_info 账号信息
  • @apiParam {string} account_period 账期
  • @apiParam {string} qualification 企业资质
  • @apiParam {string} collaboration 合作建议
  • @apiParam {string} address 厂址
  • @apiParam {string} oracle_status 状态
  • @apiParam {string} currency 主要币种
  • @apiParam {string} capacity 总体产能
  • @apiParam {string} web_url 网址
  • @apiParam {string} delivery_time 交期
• @apiError {string} code 错误码码412.供应商修改信息失败、
  • 450.供应商名称不能为空、451.英文名不能为空、452.ID（简称）不能为空、453.规模不能为空，454.注册资本不能为空
  • 455.成立时间不能为空、456.厂址不能为空、457.联系信息不能为空、458.ID（简称）格式错误!，459.成立时间格式错误
  • 460.ID（简称）重复!、461.该数据暂时不能修改
• @apiSuccessExample Success-Response:
• { * “code”: 200, //代表更改成功
  • “message”: “成功,接口响应时间：0.3272318840秒，占用内存：3,311.10KB”,
• “data”:null, * } * * @apiErrorExample {json} Error-Response:
• { * “code”: 460, * “message”: “ID（简称）重复!,接口响应时间：0.0382719040秒，占用内存：3,258.92KB.”,
• “data”: null * } */
  在命令行窗口输入：apidoc -i application/supplier/controller/ -o apidoc/
  注意：-i 后面的是你写注释的文件相对于apidoc.json的路径，-o后面是生成的文件路径相对于apidoc.json

本作品采用《CC 协议》，转载必须注明作者和本文链接