了解API接口基本知識,日常工作者可以更清楚需要輸出什麼樣的接口,什麼是關鍵接口,才能更好地進行功能規劃的提前布局和後續的壓力測試。
我們基本遇到的API接口的使用場景分為下面三個場景:
01-公司內部前後端數據交互
前端想要獲得某些數據,將傳入參數通過URL接口地址,傳遞給伺服器,伺服器根據傳入的參數了解到前端要獲得什麼數據,去資料庫查詢獲取數據,然後將所需數據返回給前端,前端拿到數據做相應的頁面展示。
比如後端拿到前端傳遞過來的數據(用戶名和密碼)和資料庫中用戶信息做比對,如果一致則返回給前端一個狀態,並且返回用戶的相關數據(暱稱、個人信息、購物車信息、收藏的商品等等),這些數據同樣是以JSON的形式傳回給前端。如果用戶名或密碼不一致,也返回給前端一個狀態。前端根據得到的狀態做出頁面的相應效果:登錄按鈕變為退出、顯示用戶暱稱、顯示購物車信息、顯示收藏信息、登錄框隱藏等,如果用戶名密碼不匹配則顯示相應的提示信息。
02-公司提供開放API接口
網站的服務商將自己的網站服務封裝成一系列API(Application Programming Interface,應用編程接口)開放出去,供第三方開發者使用,這種行為就叫做開放網站的 API,所開放的 API 就被稱作 OpenAPI(開放 API )。
網站提供開放平臺的API後,可以吸引一些第三方的開發人員在該平臺上開發商業應用,平臺提供商可以獲得更多的流量與市場份額,第三方開發者不需要龐大的硬體與技術投資就可以輕鬆快捷的創業,從而達到雙贏的目的,開放API是大平臺發展、共享的途徑,讓開發者開發一個有價值應用,付出的成本更少,成功的機會更多。
03-業務嵌套、可部署移動端
可對接至小程序、H5、移動APP等平臺,實現隨時隨地獲取數據。
現在各家的網站、平臺、系統、APP、小程序都出了自己的API接口供第三方來對接。這裡總結下需要注意的幾點:
跨平臺性,接口要能夠支持不同的終端,如Android、iOS、windowsphone以及桌面軟體、Web端等。良好的響應速度接口要為移動客戶端考慮,如移動端要寫2個特殊接口下拉刷新和上拉加載更多優化移動端的網絡情況和耗電量通用的數據交換格式 如xml和json等設計API要考慮安全問題,調用者應該是經過自己授權。
開發者API接口調用
對於私密代理、隧道代理、獨享代理、開放代理,快代理都提供了API接口,方便開發者批量獲取代理ip列表。
接口返回數據的格式支持文本、json、xml。
對於代理提取API,您可以在線生成API連結,內置到您的程序中。
正確返回結果
返回的
code
欄位為0代表成功,非0代表失敗。
以獲取開放代理接口為例,正確的返回結果樣例如下:
{
"msg":"",
"code":0,
"data":{
"count":10,
"proxy_list":[
"124.172.117.189:80",
"219.133.31.120:8888",
"183.237.194.145:8080",
"183.62.172.50:9999",
"163.125.157.243:8888",
"183.57.42.79:81",
"202.103.150.70:8088",
"182.254.129.124:80",
"58.251.132.181:8888",
"112.95.241.76:80"
]
}
}
錯誤返回結果
以獲取開放代理接口為例,錯誤的返回結果樣例如下:
{"code":-3,"msg":"參數錯誤","data":""}
公共錯誤碼