為風格統
一、便於理解，本介面文件遵循以下原則：
一. 返回json資料結構定義
訊息結構體：
// 2000返回示例
}// 4001返回示例
}
定義規則：
錯誤碼由四位組成：前兩位標識型別，後兩位標識具體錯誤
20xx : 服務正常，並返回。最常使用的是2000
40xx : 客戶端問題，介面引數、許可權等
50xx : 服務端問題。最常使用的是5000
60xx : 未知異常，服務端問題。最常使用6000
2000 ： 服務正常，且返回資料
4000 ： 引數錯誤
4001 ： 使用者登陸認證失敗
4002 ： 資料不是最新，需重新整理
4003 ： 無許可權操作
4004 ： 找不到資源
5000 ： 服務端異常
6000 ： 未知異常
一般規則
1、使用下劃線+變數名方式命名變數 user_name
2、路由命名統一 「/zxftest」 打頭，便於****
3、數值空的表示：int-
>
null
, string-
>
"", list-
>
, dict-
>
4、介面內容寫法： 變數名：變數值 // 注釋 （示例：user_name: 'zxf' // 使用者名稱） 盡可能地提供實際資料， 便於前端對資料的展示規劃
5、頁面顯示內容分「填充值」跟「選項值」，分別與後端互動獲取 （選項無需拆分成多個介面返回的就不拆，否則前後端介面連調比較辛苦，具體還是看介面常用與否決定。個人建議）
6、值是什麼型別就是什麼型別，不要都是string，合理利用boolean、int
7、非2000返回的結果，也要列出介面返回，以及說明前端可能要做的流程跳轉
8、後端介面要做字段校驗，介面文件必填非必填、型別要清晰（json schema）
9、所有介面呼叫都需要傳auth （auth：字串 + 時間戳的md5，其中字串前後端可以約定，而時間戳的話作為乙個引數也進行傳遞）
10、params 方式不好描述的請求引數，requst body 方式描述
11、所有更新的操作都需要通過update_time校驗資料是否最新， 避免多人同時操作覆蓋
python介面定義規範化 對介面規範的一些思考
起因 團隊中如果不同的專案，不同的人員可能在介面設計上有許多不統一的地方。導致了開發效率低下的問題。由於我在工作中遇到了，所以整理下來，說一說自己的一些看法。怎樣進行介面規範化 因為每個人對自己使用語言有不同的理解 http協議熟悉程度不同 思維邏輯 開發經驗不一樣。對介面規範有想法的人應該提出自己...
APP介面設計規範 如何定義視覺規範
時間 2015 09 10 16 38 34 devstore 原文 墨刀 axure after effect 用來製作互動複雜的產品原型。第一階段 概念設計和原型設計 包括腦圖設計 線框圖的設計等等。第二階段 視覺定義階段。確定了使用哪些字型 顏色 布局 形狀等元素。主要頁面的布局與視覺風格需要...
介面規範 資訊系統介面規範
實現介面的可控，有記錄，對介面邏輯徹底審查，避免漏洞。所有資訊系統之間資料非人工互動的功能或工具。接 術負責人負責編寫文件或 商編寫，技術負責人對文件負責 業務相關負責人負責對介面資料審查 專案經理對介面為主體責任人。4.2 介面開發前需充分論證，並消除風險。對低風險內容如果無法消除，必須在介面文件...