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資料，


返回錯誤的資訊

android 開發 ------- 介面文檔 規範