APP開發規範 APP介面開發規檔V1

2022-05-19 05:49:59 字數 2285 閱讀 5599

手機客戶端介面文件

版本歷史

目錄一、概述 1

1.1 有關介面 1

1.1.1介面是純資料的互動 1

1.2 介面的分類 1

1.2.1查詢類介面 1

1.2.2 操作類介面 1

1.2.3上傳**類介面 1

1.2.4推送類介面 1

二、查詢類介面格式規範 1

2.1獲取單條物件資訊 1

2.1.1 請求格式 1

2.1.2引數說明 2

2.1.3正常返回結果 2

2.2獲取列表物件資訊 2

2.2.1 請求格式 2

2.2.2引數說明 3

2.2.3正常返回結果 3

三、操作類介面 4

3.1 新增操作 4

3.1.1介面說明 4

3.1.2引數說明 4

3.1.3正常返回結果 4

3.1.4錯誤返回列表 4

3.2 修改操作 5

3.2.1介面說明 5

3.2.2引數說明 5

3.2.3正常返回結果 5

3.2.4錯誤返回列表 5

3.3 刪除操作 5

3.3.1介面說明 5

3.3.2引數說明 6

3.3.3正常返回結果 6

3.3.4錯誤返回列表 6

四、上傳**類 6

4.1 上傳檔案 6

4.1.1介面說明 6

4.1.2引數說明 7

4.1.3正常返回結果 7

4.1.4錯誤返回列表 7

4.2 **檔案 7

4.2.1介面說明 7

4.2.2引數說明 7

4.2.3正常返回結果 8

4.2.4錯誤返回列表 8

五、推送類介面 8

5.1 推送訊息 8

5.1.1介面說明 8

5.1.2引數說明 8

5.1.3正常返回結果 8

5.1.4錯誤返回列表 8

六、通用返回格式 9

6.1 正確返回 9

6.1.1介面說明 9

6.1.2引數說明 9

6.1.3正常返回結果 9

6.1.4錯誤返回列表 9

6.2 錯誤返回 9

6.2.1介面說明 9

6.2.2引數說明 10

6.2.3正常返回結果 10

6.2.4錯誤返回列表 10

七、附錄 10

7.1 通用錯誤返回列表 10

7.2 url位址資訊 11

7.2.1 主機位址 11

7.2.2 url列表 11

7.3 安全機制 11

7.3.1 驗證簽名機制 11

7.4 其他 11

7.2.1 列表資料為空的返回 11

app介面是移動裝置和業務之間進行通訊的途徑。實質就是以特定的規則通過介面直接運算元據庫的增刪改查。

查詢類介面是指客戶端傳遞一些引數,服務端根據引數依據需求,前往資料庫查詢需要的結果返回資料的一類介面。

返回型別一般有兩種。第一種是返回乙個物件,第二種是返回乙個陣列物件。

第一種比如登陸,客戶端把使用者名稱密碼上傳到介面,伺服器返回使用者的個人資訊。

第二種比如獲取客戶,客戶端把使用者的身份資訊上傳到介面,伺服器返回此身份下的所有客戶陣列集合。

操作類介面是指,客戶端通過介面進行一些增刪改的操作。比如新增乙個客戶,修改客戶資訊,或者刪除乙個客戶。伺服器一般返回執行的狀態,有的需要返回執行結果的一些資訊,比如新增客戶後,返回客戶的id。

上傳**類介面是涉及到檔案傳輸的介面。比如上傳頭像,需要上傳**到伺服器,服務端根據需求響應儲存並返回結果。比如客戶端需要顯示使用者頭像,需要讀取網路**檔案,在手機上進行顯示。

除了客戶端主動去請求服務端,獲取需要資訊之外。有時候,也存在服務端有訊息需要通知客戶端的情況,這時候就是服務端向客戶端傳送訊息。這類需求可以通過客戶端短時間類迴圈請求解決,也可以通過第三方專業推送解決。

也可以通過自己使用socket或者xmpp等協議進行開發。

2.1.4錯誤返回列表

詳見:通用錯誤返回列表

2.2.4錯誤返回列表

APP開發合同模版

甲方 乙方 2015年月日 依據 中華人民共和國合同法 及相關法律法規之規定,甲乙雙方在平等 自願的基礎上,經雙方協商一致,達成如下協議,以資共同遵照執行。一 合作方式 甲方委託乙方,乙方接受甲方委託,並根據甲方的要求定製開發甲方所需的軟體及 產品,甲方向乙方支付費用。二 合同標的 1.依據本合同約...

APP開發平台選擇方案

優勢1 提供最佳的使用者體驗,最優質的使用者介面,最華麗的互動2 針對不同平台提供不同體驗 3 可節省頻寬成本 4 可訪問本地資源 5 盈利模式明朗 劣勢1 移植到不同平台上比較麻煩 2 維持多個版本的成本比較高 3 需要通過store或market的確認4 盈利需要與第三方分成 hybridapp...

移動app開發要注意什麼

如今國內移動app市場是危機與機遇並存,由於國內並沒有乙個相對明確的開發平台,因此移動app開發更多的是處於一種分散的狀態,開發者也是在黑暗中摸索,那麼目前已上線的app軟體的應用情況如何呢?83.3 的使用者會選擇解除安裝已 的app應用。沒有想象中的好玩 影響速度 廣告多 閃退 等原因是解除安裝...