## 參數規范 1. 參數前帶\* 表示必填 2. 參數命名采用小寫加下劃線形式 3. 請求每個接口時,在`header`里帶上`XX-Token`(用戶 token),`XX-Device-Type`(類型:mobile,android,iphone,ipad,web,pc,mac,wxapp)，`XX-Api-Version`(比如1.0.0)，`XX-Wxapp-AppId`(小程序 AppId) ## 返回結果 1. 參數命名采用小寫加下劃線形式 2. 默認為`json`格式,如有變動會在返回文檔里說明格式 3. 返回結果中的`data`不能是數組，必須是對象 4. 所有遠程資源文件路徑返回可訪問 url 5. 添加數據后非特殊情況，都盡量返回添加數據主鍵 ## url規范 盡量按`restful`規范來，盡量用名詞; > 注意 api url 里的參數寫法，比如`portal/articles/:id`中`:id`只是一個占位符，你使用此 api 時應該換成你的真實參數，如`portal/articles/1` ## 控制器名 涉及到內容的，盡量使用復數形式，如`FavoritesController` ## 文件路徑 1. API輸出結果中的圖片鏈接轉化為可訪問鏈接 2. API輸出結果中文件鏈接為可訪問鏈接