android 開發 ——- 接口文檔 規范

1 接口書寫的格式:

1 用例圖

2 流程圖

3 具體的接口:

3.1請求的方式:
包括:
服務器地址 le.gxjinan.com/open/user.php?ac=login
請求方式 POST
編碼格式 UTF-8
內容的格式 application/x-www-form-urlencoded

3.2 請求的參數:
例如:
參數 類型 是否必須
說明
user String
是 手機號,郵箱,用戶名

3.2 響應信息:
請求方式 POST
編碼格式 UTF-8
數據類型 Json 數據實體,包含msg對象。
內部包含的註冊成功後用戶的ID!

3.3 返回的數據:

返回的正確信息

整體的Json 數據,

詳細的Json數據,

返回錯誤的信息

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。