api 文檔生成

2019-11-30 21:53 更新
生成api文檔基于 apidoc ,確保你已經提前安裝好了 (npm install apidoc -g)

生成API文檔

生成文檔的操作我們可以在本地進行,完成后上傳到服務器上

1.進入代碼根目錄,執(zhí)行

api文檔會默認在 root -> app -> public 目錄下創(chuàng)建文件,由于 public 目錄是默認的靜態(tài)目錄,所以發(fā)布后可以直接通過瀏覽器訪問到
npm run makePrdDoc

2.上傳api文檔到服務器

3.通過你的域名域名訪問Api文檔

https://www.yourdomain.cn/static/apidoc/index.html


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號