restful api文件生成器--神器
阿新 • • 發佈：2019-02-16
我現在還不是很懂到底什麼才是restful api，目前理解的大概就是：一種介面，只管拿引數進來，做一系列處理，返回json字串形式的結果。而restful api風格的api文件，就是用來說明這個介面需要傳進什麼引數，每個引數是什麼含義，有什麼要求，經過處理之後，該介面返回了什麼內容，每一個數據代表什麼意思。另外該工具還提供許多可直接使用的設定引數，可在頁面生成示例等。
http://apidocjs.com/ 這個是官網，以現在的能力還不能只看官網就搞定。所以藉助雷鋒們的部落格 http://www.jianshu.com/p/e3a04b5d8bb4# 這個雖然是拿的mac做測試，但是基本步驟是差不多的。需要注意的是先要安裝nodeJs的環境（雖然我也不曉得是個什麼鬼，大概就是要用那個npm工具去安裝apidoc） http://www.runoob.com/nodejs/nodejs-install-setup.html 接下來還參考了這個部落格http://www.ithao123.cn/content-5717726.html
先拿在官網下的template測一下比較靠譜~
然後可以看看官網那些個例子，所有以@api開頭的引數是什麼意思，如何設定，生成的效果是什麼樣子。
對了，生成doc必須的兩個檔案apidoc.json(或者package.doc)和寫好了註釋的原始檔。
準備好了這兩樣，開cmd，進入放檔案的目錄，打上apidoc回車。有更多高大尚的生成指令，參見官網。
這個神器生成出的效果別提多好了。把bak檔案放在一起就會生成在同一個doc中。