最近公司專案，測試需要我們提供乙個介面文件，之前是寫在wiki裡面的，需要時刻去更新，但是更新往往會不及時，這就導致了測試和開放之間存在不可調和的矛盾。 於是，便提出了這種藉口文件需求。 基於這種情況，經過調研發現， apidoc能夠很好的解決這個問題。下面就來講講apidoc的安裝使用。
apidoc.js 使用說明及其規範
安裝說明
為了不汙染大家各自開發環境，以下均假設大家在docker環境中使用，這裡有安裝說明=>enterprise linux
第一步 :安裝nodejs環境,已有可忽略（請切換為root使用者）:
# for node.js v6 lts curl –silent –location | bash – # 當上面的命令執行成功之後，即可安裝nodejs. yum install -y nodejs
第二步: 安裝apidoc.js
# 全域性安裝apidoc.js npm install apidoc -g # 如果安裝成功，可以執行下面的命令看一下自己的apidoc版本，正常情況下，應該是0.17.5+ npm view apidoc version # apidoc –help 會給出他所支援的引數
語法apidoc.js 所支援的語法比較簡單，所有支援的語法可以參考文件。大約10分鐘即可瀏覽完畢。
規範配置規範
apidoc.json配置檔案都必須給出，且配置檔案目錄必須放在與專案相同的config配置檔案目錄。內容分為倆類:
乙個最簡單的樣例(/path/to/config/apidoc.json):
語法規範
所有apidoc.js注釋應放在controller中。即目錄為controllers中的檔案。注釋目前分為倆個大類，乙個是關於類的，另乙個是關於方法的。
類注釋該注釋是指放在class somecontroller這一行之上的注釋。通常是全域性作用的，此類注釋能且僅能出現在此處。目前此類注釋只有乙個
方法注釋
即應該放在function actionsome這一行之上的注釋。此類注釋必須出現在此處。對於所有controller裡面需要用於路由的方法(即action字首的方法，均需要注釋)。所有api注釋必須包含以下資訊:
以下注釋是可選的:
乙個完整的演示如下:
/**
* @api microcommunity/vote/list 點讚列表
** @apidescription 獲取指定使用者的點讚列表或者被點讚列表.
** @apiname list
* @apigroup vote
** @apiparam [uid=當前登入使用者] 需要查詢的使用者id.
* @apiparam [offset=null] 分頁時需要的偏移量，該值會在第一次請求之後返回供客戶端使用.
* @apiparam [size=10] 期望分頁返回的資料頁大小.
* @apiparam [type=liked] 型別，分為(`liked`:點讚)和(`beliked`:被點讚).
** @apisucces***ample success-response://這裡的json可以不用格式化，因為apidoc.js會自動格式化,但是最好格式化放在這裡，方便別人看.
* ,
* "uidprofile":
* }
* ]
* },
* "status": 200,
* "message": "ok"
* }*/
生成詳細文件
unit unitfunc inte ce uses windows,messages,sysutils,classes type tfunc class tpersistent private obj name string obj desc string obj type string in l...
apidoc文件生成
1 首先要確認你的系統安裝了nodejs，然後執行npm install g apidoc即可。2 配置apidoc，在你的專案下建立apidoc.json檔案，apidoc.json說明 該檔案可以隨便放置，主要執行apidoc i src o apidoc 命令時，是在該檔案目錄下就行，具體下面...
NodeJS apidoc文件生成
3.編寫api 4.執行命令,生成文件 目前前後端分離的模式,已經深得各大公司的喜愛,然而前後端溝通的成本就增加了,我們的書面文件就成了關鍵,想想,我們在開發的時候,直接把文件丟給相應的呼叫介面的人,不管是前端後端,都開心了.按照介面文件的規範去開發,效率會提高很多.apidoc官網 二.介面文件 ...