導語:產(chǎn)品開發(fā)上線前總是避不開數(shù)據(jù)埋點和API接口,但是到底什么是API呢?API接口有什么用?我們常見的用到的API接口又有哪些呢?產(chǎn)品經(jīng)理為啥一定要懂API呢?作為PM,不一定需要知道怎么做接口,但一定要看得懂接口文檔,那接口文檔怎么看呢?學會了API接口又該如何運用呢?今天帶大家了解一下吧。
說到開發(fā)平臺就一定離不開接口,作為PM,我們不需要對接口了解的特別細。只需要知道接口是什么,有什么用,有哪些要素就行。
首先接口是什么
應用程序接口(API:Application Program Interface),是一組定義、程序及協(xié)議的集合,通過 API 接口實現(xiàn)計算機軟件之間的相互通信。 接口是一些預先定義的函數(shù),目的是提供應用程序與開發(fā)人員基于某軟件或硬件的以訪問一組例程的能力,而又無需訪問源碼,或理解內(nèi)部工作機制的細節(jié)。
?
接口有什么用
在日常開發(fā)過程中,前后端有數(shù)據(jù)交互時,前端開發(fā)同學都會問后端詢問接口,而不需問/關(guān)注具體的實現(xiàn)邏輯,高效便捷。
例如APP/物流上需展示天氣信息,那么開發(fā)同學直接接入對應的天氣/物流查詢接口就行此外,接口的開放讓許多第三方應用可以快速、輕松實現(xiàn)更多功能,如第三方支付、分享組件等等。
?
常見的API接口有哪些
1.硬件接口
生活中我們經(jīng)常會接觸接口,最常見的就是HDMI 接口和 USB 接口,而且我們知道接入某個接口就能實現(xiàn)某種功能。例如筆記本電腦可以通過 HDMI 接口連接電視,將畫面同步顯示到電視上;Switch 等游戲設(shè)備也可以通過 HDMI 接口連接電視,實現(xiàn)在電視上玩游戲。大多數(shù)人并不需要知道 HDMI 接口是怎么實現(xiàn)的,只需要接入之后能干什么就行。
2.程序接口
也就是我們今天要說的API接口,全名application program interface。其實從實際意義上講程序的接口也和硬件一樣,將內(nèi)部實現(xiàn)的功能封裝起來,像一個盒子一樣只留出一個口子,人們接入這個口子就能使用這個功能。調(diào)用的人可以很方便使用這些功能,并且可以不需要知道這些功能的具體實現(xiàn)過程,接口API 就是按照作者規(guī)定的流程去調(diào)用這些功能。實際開發(fā)中,當前端和后端有數(shù)據(jù)交互時,前端人員都會直接向后端詢問接口寫好了沒,而不會問他具體的怎么實現(xiàn)的。
舉個例子:我們?nèi)c餐吃飯
我們到商場店里吃飯,現(xiàn)在基本上都是掃碼點餐;首先掃描二維碼進入頁面,輸入就餐人數(shù),然后劈里啪啦一頓點餐并提交訂單。點完后,服務員會跟你核對菜單,然后同步到后廚,最后我們就坐等上菜。
例子中的掃碼點餐過程就可以看成是API 接口的工作過程,一個點餐的 API 接口,通過選中菜品(輸入?yún)?shù)),最后服務員上的一道道菜(輸出數(shù)據(jù)),這過程就是點餐API 接口的作用。來吃飯的顧客是接口的調(diào)用者,接口的提供者就是商家。大多數(shù)接口一定要有輸入和輸出,但是嚴格意義上不是這樣的,沒有輸入也有輸出。
接口是數(shù)據(jù)傳遞是一種表現(xiàn)。說到底API的作用就是數(shù)據(jù)傳輸。
?
產(chǎn)品經(jīng)理懂API的好處:
1、明確各個系統(tǒng)之間的數(shù)據(jù)流轉(zhuǎn),特別是功能系統(tǒng)的產(chǎn)品經(jīng)理,只有在知道了功能設(shè)計的目的、需要對外提供什么樣的接口服務,需求設(shè)計階段才能夠考慮得更加全面;
2、掌握開發(fā)總體工作量,而不局限于功能;另外,在安排項目計劃時能夠考慮到與周邊系統(tǒng)聯(lián)調(diào)的時間,計劃安排才會更加合理;
3、識別項目中的關(guān)鍵風險點,特別是一些關(guān)鍵接口、數(shù)據(jù)量大需要進行大數(shù)據(jù)壓測的接口,需要盡早安排聯(lián)調(diào)和測試,并且對周邊配合的項目提出要求。
接口文檔有哪幾部分構(gòu)成的
如下圖是一個接口文檔,它有以下幾個部分組成

接口描述:這個接口的作用和意義,以及相關(guān)的規(guī)則
接口地址:以網(wǎng)址的形式展現(xiàn),通過發(fā)送請求給這個網(wǎng)址來對接口進行交互操作
請求方法:常用的有post和get兩種方式,一個是讀接口(常用get)一個是寫接口(常用post)
請求參數(shù):請求該接口時,需提供的參數(shù),例如參數(shù)屬性:名稱、支付方式、是否必填等
返回參數(shù):接口正常響應后,返回的內(nèi)容
錯誤代碼:接口請求失敗后,返回的錯誤代碼,例如001表示為該用戶為黑名單
項目開發(fā)需要前端和后端共同完成的,接口文檔通常由后端定義并編寫接口文檔,然后再前后端聯(lián)調(diào)的時候,根據(jù)接口文檔進行數(shù)據(jù)交互。接口文檔的規(guī)范性就方便了前后端工程師有一個統(tǒng)一的文件進行溝通交流開發(fā),項目維護中或者項目人員更迭的時候,方便后期人員查看、維護。
?
如何運用API接口
最后介紹一下怎么通過瀏覽器查看接口數(shù)據(jù)吧。
首先打開任意瀏覽器(建議使用谷歌),鼠標右擊后點擊“查看”或者直接按“F12 鍵”打開發(fā)者工具,然后選擇"network"—>“XHR”,就會看到很多接口請求,按需找到請求接口,查看對應返回數(shù)據(jù)即可。
大多數(shù)情況下,可以通過接口狀態(tài)碼和消息提示去判斷是后端還是前端的問題。但是有些問題比較隱蔽,即使狀態(tài)碼返回為成功的碼,但問題依舊存在,這種情況很有可能是后臺某細節(jié)錯誤。