1. 安裝node

2. node.js 安裝api.doc

npm install apidoc -g

3. 在項目的主目錄新建一個apidoc.json文件

{
  "name": "AlphaPortalService接口文檔",
  "version": "1.0.0",
  "description": "AlphaPortalService接口文檔",
  "title": "AlphaPortalService接口文檔3",
  "url" : "http://localhost:8080/alphaPortalService",
  "sampleUrl" : "http://localhost:8080/alphaPortalService"
}

4.給controller方法上添加注釋

  /**
     * @api {method} path [title]
     * @apiGroup name
     * @apiVersion version
     * @apiDescription text  
     * @apiParam {String} account 請求樣例
     * @apiParam {String} password 請求樣例
     * @apiParam {String} mobile 請求樣例
     * @apiParam {int} vip = 0  請求樣例
     * @apiParam {String} [recommend] 請求樣例
     * @apiParamExample {json} 請求樣例
     * @apiSuccess (200) {String} msg 請求樣例
     * @apiSuccess (200) {int} code 0 請求樣例
     * @apiSuccessExample {json} 返回樣例:
     * {"code": 200,"msg": "成功!","body": "hello"}
     */

5. 用apidoc命令生成文檔界面

1. 在工程項目的外層目錄建立輸出文檔目錄：ex:apidoc
2. 輸入命令：
   apidoc -i AlphaPortalService/ -o apidoc/  
3. -i 輸入目錄 -o 輸出目錄
4. AlphaPortalService為工程名
5. 打開index.html,可以看到文檔頁面

@RestController
public class Test1Controller {

    /**
     * @api {POST} /register 注冊用戶
     * @apiGroup Users
     * @apiVersion 1.0.0
     * @apiDescription 用于注冊用戶
     * @apiParam {String} account 用戶賬戶名
     * @apiParam {String} password 密碼
     * @apiParam {String} mobile 手機號
     * @apiParam {int} vip = 0  是否注冊Vip身份 0 普通用戶 1 Vip用戶
     * @apiParam {String} [recommend] 邀請碼
     * @apiParamExample {json} 請求樣例：
     * ?account=sodlinken&password=11223344&mobile=13739554137&vip=0&recommend=
     * @apiSuccess (200) {String} msg 信息
     * @apiSuccess (200) {int} code 0 代表無錯誤 1代表有錯誤
     * @apiSuccessExample {json} 返回樣例:
     * {"code":"0","msg":"注冊成功"}
     */
    @PostMapping("/register")
    public R hello(@RequestParam("account") String account,
                        @RequestParam("password")  String password,
                        @RequestParam("mobile")  String mobile,
                        @RequestParam("vip")  int vip,
                        @RequestParam("recommend")  String recommend) {
        log.info("account:{},password:{},mobile:{},vip:{},recommend:{}", account, password, mobile, vip, recommend);
        return R.ok("hello");
    }
}

如下:

image.png

文檔：

image.png

image.png