android开发接口文档模板
生活随笔
收集整理的這篇文章主要介紹了
android开发接口文档模板
小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.
1 接口書(shū)寫(xiě)的格式:
1 用例圖
2 流程圖
3 具體的接口:
3.1請(qǐng)求的方式:
包括:
服務(wù)器地址 le.gxjinan.com/open/user.php?ac=login
請(qǐng)求方式 POST
編碼格式 UTF-8
內(nèi)容的格式 application/x-www-form-urlencoded
3.2 請(qǐng)求的參數(shù):
例如:
參數(shù) 類(lèi)型 是否必須
說(shuō)明
user String 是 手機(jī)號(hào),郵箱,用戶(hù)名
3.2 響應(yīng)信息:
請(qǐng)求方式 POST
編碼格式 UTF-8
數(shù)據(jù)類(lèi)型 Json 數(shù)據(jù)實(shí)體,包含msg對(duì)象。
內(nèi)部包含的注冊(cè)成功后用戶(hù)的ID!
3.3 返回的數(shù)據(jù):
返回的正確信息
整體的Json 數(shù)據(jù),
詳細(xì)的Json數(shù)據(jù),
返回錯(cuò)誤的信息
總結(jié)
以上是生活随笔為你收集整理的android开发接口文档模板的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: centos安装禅道的步骤
- 下一篇: 专题三--1005