前言
每個項目進行研發之前，都會有很多的相對應的文檔，當然比較重要的一個就是接口文檔，當然接口文檔版本也有很多，這邊隻是把自己寫文檔的一部分内容寫個示例記錄一下，友善以後自己檢視。當然大家有很好的建議和意見可以關注和留言交流。
設定描述
設計描述，主要是介紹項目接口文檔的業務及主要功能介紹，有互動方式、JSON資料互動格式、命名規則等做細分講解。
1)接口的調用方式：
移動端通過WebService和其他通用的請求方式，調用伺服器接口，傳回JSON資料。
2)JSON的結構： 請求失敗示例
{
"status":"0",
"message":"您尚未登入，請登入後繼續操作"
}
請求成功示例
{
"status":"1",
"message":"",
"data":{
"userId":"565562",
"userName":"huangxianfeng",
"workList":[
{
"workId":"245632",
"workName":"完成登陸功能的實作"
},
{
"workId":"956412",
"workName":"完成編碼的格式轉換"
}
]
}
}
字段解析
status：1成功、0失敗
message：錯誤日志，接口通路錯誤的時候傳回的錯誤提示文字，通路成功 的時候為空 字元串
data：伺服器傳回的業務資料
3)約定
1.JSON資料中的所有元素标簽均以小寫字母開頭，并遵循駝峰命名法命名
2.JSON的編碼格式需為UTF-8的編碼格式
3.傳入參數必須要加入tranCode交易碼(此參數為必須)
4.請求的參數名稱也是要小寫字母開頭(駝峰命名法命名)
4)具體接口文檔編寫示例‘
以上就是所有接口文檔的筆記，如若大家有什麼好的建議和意見，可以留言或關注交流。