ApiDoc 文檔使用方式

一、安裝node.jsnode

二、打開node.js 命令窗(shell)鍵入npm install apidoc -gshell

自動安裝(幾分鐘)npm

三、api

C:\Users\user\AppData\Roaming\npm\node_modules\apidoc\example 目錄下的example.js是文檔的模板,用來生成咱們須要的文檔服務器

在C:\Users\user\AppData\Roaming\npm\node_modules\apidoc下新建一個文件夾doc(自定義便可),做爲文檔輸出目錄文檔

Ps:所有安裝爲默認的狀況下 (個人是C:\Users\Adminstator\AppData\Roaming\npm\node_modules\apidoc\example)模板

四、按格式修改 example.js  保存module

五、命令窗(shell)鍵入 apidoc -i C:\Users\Adminstator\AppData\Roaming\npm\node_modules\apidoc\example -o C:\Users\Adminstator\AppData\Roaming\npm\node_modules\apidoc\doc(doc爲保存生成的文件)文件

返回info:Done上傳

六、在服務器上新建文件夾將生成doc裏面的內容上傳  並將訪問連接指向index

相關文章
相關標籤/搜索