因不同人員的開發習慣不同，造成前后端連調時許多問題要重復確認。也會出現因前后端人員對
默認值的期望不同而造成的代碼缺陷。因此制定本接口規范，規范前后端的開發標准。
參考如下接口文檔格式：
接口名稱：審核列表
接口描述：接口的使用場景
接口URL： {service}/rider/check/r/new/list
請求方式：get|post
請求參數（json對象）// 可以根據需要讓后端說明接受的是params還是model
數據格式：{key1: value1, key2: value2, ...}
參數名
數據類型
是否必填
取值范圍
含義
checked
int
是
(0,10)
審核狀態
userName
string
否
[0, 10]
用戶名
userPhone
string
否
手機號
orgId
int
否
組織ID
cityId
int
否
城市ID
orgType
int
否
組織類型
pageNum
int
否
頁碼號
pageSize
int
否
每頁數據
返回結果
1、返回結果要求是json對象
2、數據格式：{code: 0, msg: "ok", data: {model:{}}} // 真實數據最好放在data內部，前端統一從data里面獲取
3、返回數據字段，都要有字段描述，明確告知前端字段的作用，如下注釋內容
{
"code": 0,
"msg": "成功",
"data": {
"list": [{
"accountId": 0, // 賬號ID
"accountSource": 0, // 賬號來源
"bmOrgId": 80, // 組織ID
"bmRoleCode": 0, // 角色Code
"bmUserId": 112, // bmID
"cardNo": "140***********5811", // 身份證號
"cardNoChanged": false, // 身份證是否修改
"checked": 0, // 審核狀態
"ctime": "2018-03-26 19:54:55", // 創建時間
"faceUrlChanged": false, // 頭像是否修改
"gender": 0, // 性別 0:男，1:女
"genderChanged": false, // 性別是否改變
"headPortraitUrlChanged": false, // 用戶頭像是否改變
"healthCertificateDateChanged": false, // 健康證日期是否改變
"healthCertificateFaceUrlChanged": false, // 健康證頭像是否改變
"healthCertificateType": 0, // 健康證類型
"healthCertificateTypeChanged": false, // 健康證類型是否改變
"healthCertificateUrlChanged": false, // 健康證圖片是否改變
"id": 111, // 唯一標識
"idCardUrlChanged": false, // 身份證圖片是否改變
"isCheckHealthCertificate": 0, // 是否校驗健康證
"jobType": 0, // 工作類型
"mobile": "140****1112", // 電話
"name": "姓名", // 姓名
"nameChanged": false, // 名字是否改變
"opUserId": 0, // 操作人ID
"opUserType": 0, // 操作人類型
"orgName": "加盟站", // 組織名稱
"orgType": 0, // 組織類型
"orgTypeName": "自營", // 組織類型名稱
"originOrgId": 0, // 源組織ID
"utime": "2018-03-26 19:54:55", // 最近更新時間
"valid": 0 // 是否有效
}],
"pageNo": 10,
"pageSize": 20,
"totalCount": 2000
}
}
4、數據直接可用，不用前端二次加工（如排序、計算）
5、列表展示數據如果包含字典類型數據，需要后端直接給出展示名稱（前端不做映射處理）
6、按需給出所需字段，盡可能去掉前端不需要的多余字段
7、對於各種字段類型，如果不存在必須返回該字段，缺省值如下
類型
缺省值
Array
[ ] // 空數組
String
'' // 空串
Number
null
Json 對象
null
linux時間戳
0
8、對於 復雜的數據類型，比如 result: {a: '字段1', b: '字段2' }, 假如 result為空，則返回 result: null，而不是 result : { a: '', b: ''}
分頁約定：
1、請求從第一頁開始、即pageNumber 從1開始
2、后端需返回 pageCount(本次查詢返回多少條記錄), totalPage（總頁數）。
原文鏈接：https://blog.csdn.net/qq_22010473/article/details/90473372