RESTful api文檔生成工具:apidoc

jopen 10年前發布 | 78K 次閱讀 apidoc 程序文檔工具

apidoc是一個簡單的RESTful api文檔生成工具，它從代碼注釋中提取特定格式的內容，生成文檔。目前支持c系列注釋風格的語言和ruby。具體文檔可參考:http://apidoc.site/ 

/*
 @api get /users 獲取所有的用戶信息
 @apiGroup users
 @apiQuery page int 顯示第幾頁的內容
 @apiQuery size int 每頁顯示的數量
 @apiSuccess 200 ok
 @apiParam count int 符合條件的所有用戶數量
 @apiParam users array 用戶列表。
 @apiExample json
 {
     "count": 500,
     "users": [
        {"id":1, "username": "admin1", "name": "管理員2"},
        {"id":2, "username": "admin2", "name": "管理員2"}
     ],
 }
 @apiExmaple xml
 <users count="500">
     <user id="1" username="admin1" name="管理員1" />
     <user id="2" username="admin2" name="管理員2" />
 </users>
 */

安裝 

go get github.com/caixw/apidoc

項目主頁：http://www.baiduhome.net/lib/view/home/1447242071257

 本文由用戶 jopen 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
 轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！