apidoc 自动生成api文档

1. 下载node.js 安装
2. 安装npm淘宝镜像
3. 安装apidoc
4. 项目应用目录目录下新建apidoc.json文件，例如tp的application目录

{
  "name": "JD SHOP Api",
  "version": "1.0.0",
  "description": "JD SHOP Api",
  "title": "JD SHOP Api",
  "url" : "http://127.0.0.1:99/api/v1",
  "sampleUrl":"http://127.0.0.1:99/api/v1"
}

5.注释：每一个方法前书写

/**
 * @api {get} /login login
 * @apiVersion 1.0.0
 * @apiName login
 * @apiGroup User
 *
 * @apiDescription 登录
 *
 * @apiHeader {String} token Token必需填写.
 * @apiHeaderExample {json} Header-Example:
 *     {
 *       "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ3d3cueXVhbmdla2VqaS5jb20iLCJpYXQiOjE0Nzg3NTI0NDgsImV4cCI6MTU1MDc1MjQ0OCwiZW1wbG95ZWVfaWQiOiIyMiIsInNob3BfaWQiOiIzNyIsInVzZXJfaWQiOiIzOTEiLCJhZG1pbl9pZCI6IjExIn0.Z8Qg-XAST_Pi47hPU21RUOOde5g7OWdwMNBMMwNAGTc"
 *     }
 *
 * @apiParam {string} username  用户名
 * @apiParam {string} pwd  密码
 */

6.phpstorm生成注释

file>Setting

7.运行命令,生成文档 apidoc -i application -o public/doc

public:文档保存路径

doc：文档名称