在寶塔下使用apidoc

童年的回忆發表於2024-09-01
API

1.先安裝ndoe版本管理器 安裝node的v14版本

如果回到系統命令列下輸入node命令無法使用，則需要選擇命令列版本

2.在命令列下安裝apidoc:

npm install apidoc -g

安裝完後如果發現apidoc命令無法使用，則需要建立軟連線：

ln -s /www/server/nodejs/v14.17.6/bin/apidoc /usr/bin/apidoc

3.建立api.json配置檔案：

{
  "name": "My Project",
  "title": "My API",
  "description":"API介面文件",
  "url" : "http://api.demo.com",
  "version": "0.1.0"
}

4.新建目錄src,建立api文件demo:

/**
 * @api {get} /shop/getList/:id 透過商家id獲取店鋪列表
 * @apiGroup Shop
 *
 * @apiParam (params) {int} id      商家id
 * @apiParamExample 請求引數Demo:
 *      {
 *        "id": 2,
 *       }
 *
 * @apiSuccess {Array} article 返回相應id的文章資訊
 *
 * @apiSuccessExample Success-Response:
 *    HTTP/1.1 200 OK
 *      {
 *        "tile": "文章標題2",
 *        "date": 1483941498230,
 *        "author": "classlfz",
 *        "content": "文章的詳細內容"
 *       }
 *
 * @apiSampleRequest http://51.133.54.142
 */

/**
 * @api {post} /shop/add 新增商家
 * @apiGroup Shop
 *
 * @apiBody {String} name      商家名
 * @apiBody {String} address      商家地址
 *
 * @apiSuccessExample Success-Response:
 *    HTTP/1.1 200 OK
 *      {
 *        "tile": "文章標題2",
 *        "date": 1483941498230,
 *        "author": "classlfz",
 *        "content": "文章的詳細內容"
 *       }
 *
 * @apiSampleRequest http://51.133.54.142
 */

5.新建文件輸出目錄:doc

現在的目錄結構是這樣的：

6.使用命令生成文件：

apidoc -c apidoc.json

去doc目錄下檢視：

代表生成成功，如果沒生成成功，則需要檢查src目錄下的php檔案，檢查生成文件。

最終效果：

相關文章