前言
一、設定描述
設計描述，主要是介紹專案介面文件的業務及主要功能介紹，有互動方式、json資料互動格式、命名規則等做細分講解。
1）介面的呼叫方式：
移動端通過webservice和其他通用的請求方式，呼叫伺服器介面，返回json資料。
2）json的結構：
請求失敗示例
,]}
}
status：1成功、0失敗
message：錯誤日誌，介面訪問錯誤的時候返回的錯誤提示文字，訪問成功 的時候為空 字串
data：伺服器返回的業務資料
1.json資料中的所有元素標籤均以小寫字母開頭，並遵循駝峰命名法命名
2.json的編碼格式需為utf-8的編碼格式
3.傳入引數必須要加入trancode交易碼（此引數為必須）
4.請求的引數名稱也是要小寫字母開頭（駝峰命名法命名）
4）具體介面文件編寫示例
yapi 介面文件 介面文件神器YApi
阿八個人部落格 1190000020220258 什麼是yapi github 官網上是這麼介紹的 yapi 是乙個可本地部署的 打通前後端及qa的 視覺化的介面管理平台 可以這麼說yapi兼具swagger,rap2,postman的各項優點why yapi 如果你想要乙個好用的介面管理平台，那麼...
介面文件格式
幻寵大陸 專案協議文件 協議格式說明 遊戲系統中協議是由兩部分組成 協議頭 協議體。其中協議頭的資料長度為固定。如下顯示 客戶端傳送的訊息格式 字段意義 字段型別 說明訊息長度 int描述協議體的長度，包括當前 訊息頭short 協議 id 訊息回執碼 short 壓縮或加密的標識，或者是回執碼 訊...
關於介面文件
其實對於介面文件，就是用來傳遞介面的資訊，包括介面的資料傳遞，資料的請求，那麼，文件的可讀性就異常重要了。當然word，txt，都可以用來寫介面文件，只不過，對於word的各種格式，不見得所有程式猿都了然於胸，這個時候想讓介面文件變得簡潔美觀，可讀性優良的話，markdown就可以閃亮登場了。下面記...