SpringBoot非官方教程 | 第十二篇：springboot集成apidoc

首先聲明下，apidoc是基於註釋來生成文檔的，它不基於任何框架，並且支持大多數編程語言，爲了springboot系列的完整性，因此標了個題。

1、apidoc簡介

apidoc經過在你代碼的註釋來生成api文檔的。它對代碼沒有侵入性，只須要你寫好相關的註釋便可，而且它僅經過寫簡單的配置就能夠生成高顏值的api接口頁面。它基於node.js，因此你須要安裝node.js環境。node.js安裝，點擊這裏。這裏就不介紹。

2、準備工做

安裝完node.js安裝api.doc,它的項目源碼：https://github.com/apidoc/apidoc 。

經過命令安裝：

npm install apidoc -g

3、註釋怎麼寫

• @api

  @api {method} path [title]
  
  method：請求方法，
  path：請求路徑 
  title(可選)：標題

• @apiDescription

  @apiDescription text
  text說明

• @apiError

  @apiError [(group)] [{type}] field [description]
  
  （group）（可選）：參數將以這個名稱分組，不設置的話，默認是Error 4xx 
  {type}（可選）：返回值類型，例如：{Boolean}, {Number}, {String}, {Object}, {String[]} 
  field：返回值字段名稱 
  descriptionoptional（可選）：返回值字段說明

• @apiGroup

  @apiGroup name
  name：組名稱，也是導航的標題

更多註釋，參見官方文檔：http://apidocjs.com/#params

4、寫給栗子

首先寫配置文件

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

{
  "name": "example",
  "version": "0.1.0",
  "description": "A basic apiDoc example"
}

更多配置參考：http://apidocjs.com/#configur...

寫個註釋:

/**
 * @api {POST} /register 註冊用戶
 * @apiGroup Users
 * @apiVersion 0.0.1
 * @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":"註冊成功"}
 */

用apidoc命令生成文檔界面

先cd到工程的外層目錄，並在外層目建個輸出文檔的目錄，我建的是docapi。

輸命令：

apidoc -i chapter4/ -o apidoc/

-i 輸入目錄 -o 輸出目錄

chapter4是個人工程名。

能夠看到在apidoc目錄生成了不少文件:

打開index.html,能夠看到文檔頁面:

5、參考資料

apidoc

apidocjs.com

使用apidoc 生成Restful web Api文檔