最近一段時間一直在做APP接口,總結一下APP接口開發以來的心得,與大家分享:
1. 客戶端/服務器接口請求流程:
安卓/IOS客戶端 –> PHP接口 –> 服務器端 –> 數據處理 –> 返回值(客戶端接收並處理)
APP的通信方式:
客戶端 (接口地址:http://app.com/api.php?format=xml/json)
客戶端APP ------------------------------> 服務器
<-----------------------------
返回數據
2.客戶端APP通信格式區別
1.XML:擴展標記語言 ,(用於標記電子文件使其具有結構性的標記語言,可以用來標記數據、定義數據類型,是一種允許用戶對自己的標記語言進行定義的源語言)
2.JSON:一種輕量級的數據交換格式,具有良好的可讀和便於快速編寫的特性。可在不同平台之間進行數據交換。JSON采用兼容性很高的、完全獨立於語言文本格式,同時也具備類似於C語言的習慣(包括C, C++, C#, Java, JavaScript, Perl, Python等)體系的行為。
JSON格式如下:
XML的可讀性要好,JSON的生成數據性 (json_encode(數組)) 傳輸速度方面要好
3.客戶端請求方式/傳值類型
3.1 GET請求:Get請求參數通過URL地址傳遞,在URL中傳送的參數是有長度限制的,傳值大小為2KB,而且相對於POST方式不是很安全。
3.2 POST請求:POST請求參數通過request body傳遞參數,數據傳輸安全性較高,而且支持多種數據格式的傳輸,如,數組、字符串等等。
POST的請求如下:
最直觀的區別就是GET把參數包含在URL中,POST通過request body傳遞參數。
3.文檔規范
接口文檔主要包括:文檔名稱、接口名稱、請求地址、請求方式、請求參數、返回值、參數注釋以及狀態碼。
3.1 請求示例:
3.2 返回示例:
3.3 參數注釋:
3.4 返回結果
常用的有在線文檔和doc文檔兩種,個人推薦在線文檔,https://apizza.net
在團隊協作開發中,文檔規范能更快的提高團隊工作效率,降低溝通成本,加之APP版本迭代,方便快速查閱文檔。
4.接口調試
客戶端在請求接口時,根據文檔接口傳遞相關參數,類似於我們做表單提交時,傳遞的參數一樣。客戶端請求接口時,一般流程如下:
接口地址:http://api.nanniwan.com/user/ls.api
接口參數:
① 必要性的token驗證(即用戶登錄驗證)
② 必傳參數:接口接收數據並做處理(具體根據業務需求定義)
③ 請求 響應 返回值
可以通過Postman來模擬調試接口,具體如下:
至此,APP接口基礎篇就講解完畢,具體實踐,請看一下節。
---------------------
作者:No.1117
來源:CSDN
原文:https://blog.csdn.net/qq_29920751/article/details/83271818
版權聲明:本文為博主原創文章,轉載請附上博文鏈接!