Apidoc 使用方法

Windows下载： https://nodejs.org/dist/v8.11.3/node-v8.11.3-x64.msi

Mac下载： https://nodejs.org/dist/v8.11.3/node-v8.11.3.pkg

安装完成 node 之后 安装 apidoc 模块

**Windows：**

1. ctrl + r

2. node -v

3. npm install -g apidoc

**Mac：**

1. 打开终端

2. node -v

3. npm install -g apidoc

至此 apidoc 文档的环境和相关依赖安装完成

Apidoc 使用方法（c/c++, java, c#, javascript, typescript, php, python, ...）

apidoc.json:  http://localhost:8080/apidoc.zip

下载此文件放置到项目的根目录

此文件主要内容如下：

{
    "name": "智慧港城在线 API 文档",
    "version": "0.1.0",
    "description": "智慧港城在线 API 文档",
    "title": "智慧港城在线 API 文档",
    "url": "http://localhost:8088/projectName"
}

项目中接口注释写法

/**
 * @api {post} /order/queryOrderInfo
 * @apiDescription 查询订单列表信息
 * @apiGroup Order APIs
 *
 * @apiParam {String} userid 用户ID
 * @apiParam {String} [orderdstatus] 订单状态
 * @apiParam {String} pageNo 当前页
 * @apiParam {String} pageSize 每页条数
 *
 * @apiParamExample {json} 请求参数格式:
 *      {
 *          "userid": "2aa98e233fe34ee59c44825fe33b7990",
 *          "orderdstatus":"1",
 *          "pageNo": "1",
 *          "pageSize":"10"
 *      }
 *
 * @apiVersion 1.0.0
 *
 * @apiSuccessExample {json} 正确返回值:
 *      {
 *          " data": {
 *              "pageInfo": {
 *                  "total": 6,
 *                  "pageSize": 10,
 *                  "pageNum": 1
 *              },
 *              "list": [
 *                  {
 *                      "id": "c11e1dbf-36e3-4410-bef2-f83b22f51ba7",
 *                      "isNewRecord": false,
 *                      "shopid": "eaa57f8467c94a18a6569b9a7098fbb3",
 *                      "totalprice": 5140,
 *                      "buytime": "2018-08-06 21:26:31",
 *                      "userid": "2aa98e233fe34ee59c44825fe33b7990",
 *                      "addressid": "3f9ebd9d756c499eb0027b16da63cba9",
 *                      "orderdstatus": "1",
 *                      "address": "山西省太原市小店区强强强",
 *                      "name": "你好",
 *                      "phonenum": "13111111111",
 *                      "isdaflut": "1",
 *                      "goodsResult": [
 *                          {
 *                              "goodid": "815c8c3f2ced47119f3a6f2f9aaa4476",
 *                              "goodcount": "1",
 *                              "goodmoney": "4345",
 *                              "goodname": "测试商品",
 *                              "gooddesc": "是打发斯蒂芬",
 *                              "photoUrl": "http://115.28.224.105:8001/zhgcUser/2018-06-30/zhgc1530342624522.jpg"
 *                          },
 *                          ...
 *                      ]
 *                  },
 *                  ...
 *             ]
 *         }
 *
 * @apiErrorExample {json} 错误返回值:
 *      {
 *           "state":"0",
 *           "message":"查询失败",
 *           "data":""
 *      }
 *
 * @apiSampleRequest /projectName/order/queryOrderInfo
 */

APIDOC 文档生成

cd 至项目根目录执行

apidoc -i src/main/java/com/thinkgem/jeesite/modules -o src/main/webapp/apidoc

参数说明

    ** -i ** // 此参数后面的参数为写有注释的源代码目录

    ** -o ** // 此参数后面的参数为生成的 api 文档目录（需要注意的是 后台要配置此目录的访问权限）

查看地址  

http://localhost:8080/projectName/apidoc/