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：文件名稱