api 文檔生成

生成api文檔基于 apidoc ,確保你已經(jīng)提前安裝好了 (npm install apidoc -g)

生成API文檔

生成文檔的操作我們可以在本地進(jìn)行，完成后上傳到服務(wù)器上

1.進(jìn)入代碼根目錄，執(zhí)行

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

npm run makePrdDoc

2.上傳api文檔到服務(wù)器

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

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