安裝全局依賴apidoc

npm install apidoc -g復制代碼

創建項目目錄

創建src文件夾，并創建apidoc.json文件

{ "name": "項目名稱", "version": "1.0.0", "description": "項目名稱- 接口文檔", "title": "項目名稱", "url" : "http://localhost:8080/api", "sampleUrl": "http://localhost:8080/api", "header": { "title": "頂部說明", "filename": "header.md" }, "footer": { "title": "底部說明","filename": "footer.md" }, "order": ["Error","Define","PostTitleAndError","PostError" ] }復制代碼

src下創建footer.md

底部說明 1. 底部具體內容說明復制代碼

src下創建header.md

頂部說明 1. 頂部具體內容說明復制代碼

創建public.js文件，用來描述接口的文檔js，簡單描述說明：

• • @apiDefine? 用來定義變量

  • @apiGroup 歸類接口組別
  • @apiDescription 接口描述
  • @apiName 接口名稱
  • @apiPermission 接口需要的權限（token）
  • @apiParam 接口參數
  • @apiHeaderExample 接口Headers請求參數實例
  • @apiSuccess 成功響應
    /** * @apiDefine personalGroup 個人信息 *//*** @api {post} /v1/register 注冊* @apiName register* @apiGroup personalGroup* @apiDescription 用戶注冊** @apiParam {String} mobile 手機號* @apiParam {String} password 密碼.* @apiParam {Int} sms_code 驗證碼.* @apiParam {Int} invite_code 邀請碼.** @apiSuccess (200) {Number} status 狀態碼 10000表示陳功.* @apiSuccess (200) {String} msg 提示語.* @apiSuccess (200) {Json} data 返回數據.*//*** @api {get} /v1/account 獲取資產* @apiName getAccount* @apiGroup publicGroup* @apiPermission token** @apiParam (headers參數) {String} token 在請求頭headers中添加token信息** @apiHeaderExample {json} Headers:* {* "Content-Type": "application/json;charset=UTF-8",* "token":"sfdasd"* }* @apiSuccessExample {json} 正確響應：* HTTP/1.1 200 OK* {* status:10000,* msg:"發送成功",* data:{* ...* }* }* @apiSuccess (200) {number} status 狀態碼 10000表示陳功.* @apiSuccess (200) {String} msg 提示語.* @apiSuccess (200) {String} data 返回數據.*/ 復制代碼

運行

apidoc -i src/ -o apidoc/復制代碼

部署

將apidoc中的目錄文件部署到web服務器中即可訪問，生成目錄如下：

轉載于:https://juejin.im/post/5cf71822f265da1b6028f0e1

《新程序員》：云原生和全面數字化實踐50位技術專家共同創作，文字、視頻、音頻交互閱讀

總結

以上是生活随笔為你收集整理的apidoc文档项目构建的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。