【Android】接口文檔

前言

每一個項目進行研發以前，都會有不少的相對應的文檔，固然比較重要的一個就是接口文檔，固然接口文檔版本也有不少，這邊只是把本身寫文檔的一部份內容寫個示例記錄一下，方便之後本身查看。固然你們有很好的建議和意見能夠關注和留言交流。

設置描述

設計描述，主要是介紹項目接口文檔的業務及主要功能介紹，有交互方式、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）具體接口文檔編寫示例‘

以上就是全部接口文檔的筆記，如若你們有什麼好的建議和意見，能夠留言或關注交流。