很可惜 T 。T 您現(xiàn)在還不是作者身份，不能自主發(fā)稿哦～
如有投稿需求，請(qǐng)把文章發(fā)送到郵箱tougao@appcpx.com，一經(jīng)錄用會(huì)有專人和您聯(lián)系
咨詢?nèi)绾纬蔀榇河鹱髡哒?qǐng)聯(lián)系：鳥(niǎo)哥筆記小羽毛（ngbjxym）
產(chǎn)品經(jīng)理可能需要了解第2個(gè)技術(shù)知識(shí)點(diǎn)：什么是API接口？接口有那幾部分組成？怎么通過(guò)接口定位是前端bug還是后端bug？
1. 接口是什么
2. 接口地址組成部分
3. 接口請(qǐng)求方式
4. 接口返回內(nèi)容
5. 接口文檔規(guī)范
6. 如何通過(guò)接口判斷問(wèn)題是后端還是前端造成的
說(shuō)到開(kāi)發(fā)平臺(tái)就一定離不開(kāi)接口，作為PM，我們不需要對(duì)接口了解的特別細(xì)。只需要知道接口是什么，有什么用，有哪些要素就行。
1. 接口是什么
(1) 硬件接口
生活中我們經(jīng)常會(huì)接觸接口，最常見(jiàn)的就是HDMI接口和USB接口，而且我們知道接入某個(gè)接口就能實(shí)現(xiàn)某種功能。
例如筆記本電腦可以通過(guò)HDMI接口連接電視，將畫(huà)面同步顯示到電視上；Switch等游戲設(shè)備也可以通過(guò)HDMI接口連接電視，實(shí)現(xiàn)在電視上玩游戲。
大多數(shù)人并不需要知道HDMI接口是怎么實(shí)現(xiàn)的，只需要接入之后能干什么就行。(HDMI是一種高清視頻接口，可用來(lái)傳輸圖像信號(hào)和音頻信號(hào)。)
(2) 程序接口api（application program interface）
其實(shí)從實(shí)際意義上講程序的接口也和硬件一樣，將內(nèi)部實(shí)現(xiàn)的功能封裝起來(lái)，像一個(gè)盒子一樣只留出一個(gè)口子，人們接入這個(gè)口子就能使用這個(gè)功能。
調(diào)用的人可以很方便使用這些功能，并且可以不需要知道這些功能的具體實(shí)現(xiàn)過(guò)程，接口API就是按照作者規(guī)定的流程去調(diào)用這些功能。
實(shí)際開(kāi)發(fā)中，當(dāng)前端和后端有數(shù)據(jù)交互時(shí)，前端人員都會(huì)直接向后端詢問(wèn)接口寫(xiě)好了沒(méi)，而不會(huì)問(wèn)他具體的怎么實(shí)現(xiàn)的。
【舉個(gè)例子：點(diǎn)餐吃飯】
我們到商場(chǎng)店里吃飯，現(xiàn)在基本上都是掃碼點(diǎn)餐；首先掃描二維碼進(jìn)入頁(yè)面，輸入就餐人數(shù)，然后劈里啪啦一頓點(diǎn)餐并提交訂單。點(diǎn)完后，服務(wù)員會(huì)跟你核對(duì)菜單，然后同步到后廚，最后我們就坐等上菜。
例子中的掃碼點(diǎn)餐過(guò)程就可以看成是API接口的工作過(guò)程，一個(gè)點(diǎn)餐的API接口，通過(guò)選中菜品（輸入?yún)?shù)），最后服務(wù)員上的一道道菜（輸出數(shù)據(jù)），這過(guò)程就是點(diǎn)餐API接口的作用。
來(lái)吃飯的顧客是接口的調(diào)用者，接口的提供者就是商家。大多數(shù)接口一定要有輸入和輸出，但是嚴(yán)格意義上不是這樣的，沒(méi)有輸入也有輸出。
接口是數(shù)據(jù)傳遞是一種表現(xiàn)。
【再舉個(gè)超簡(jiǎn)單的例子：點(diǎn)燈開(kāi)發(fā)】
接口的請(qǐng)求可以理解為接口就是一個(gè)電燈的開(kāi)關(guān)，它在接口里面給你提供了一個(gè)參數(shù)，參數(shù)的值一個(gè)是 “開(kāi)”、另一個(gè)是“關(guān)”，分別對(duì)應(yīng)“燈亮”、“燈滅”。
通過(guò)這兩個(gè)例子，想必大家對(duì)接口的概念有所理解了吧，接下來(lái)我們來(lái)看看接口有那幾部分構(gòu)成的。
2. 接口地址組成部分
接口地址由請(qǐng)求協(xié)議、IP地址、端口、接口名稱、參數(shù)組成。
(1) 請(qǐng)求協(xié)議
http：普通的http請(qǐng)求；
https：加密的http請(qǐng)求，傳輸數(shù)據(jù)更加安全；
ftp：文件傳輸協(xié)議，主要用來(lái)傳輸文件。
(2) 請(qǐng)求IP
就是指提供接口的系統(tǒng)所部署的服務(wù)器地址，通常用映射IP的域名來(lái)代替；
(3) 端口
如果不填端口，默認(rèn)是80，否則需要填寫(xiě)端口號(hào)；
(4) 接口名稱
好的接口命名能讓開(kāi)發(fā)者便于閱讀和理解，如 “news/add” 和 “news/update”，一看就知道新聞添加和新聞信息編輯的接口。
(5) 接口參數(shù)/參數(shù)值
參數(shù)在接口路徑后，用“?”來(lái)表示路徑地址結(jié)束，后面跟著的都是參數(shù)，用“&”來(lái)區(qū)分參數(shù)個(gè)數(shù)(GET請(qǐng)求傳參方式)。
3. 接口請(qǐng)求方式
一般采用的是HTTP協(xié)議的POST和GET請(qǐng)求；GET請(qǐng)求方式參數(shù)通常拼接在接口地址后面；
而POST請(qǐng)求則不會(huì)拼接在后面，是保證了數(shù)據(jù)的安全性；
4. 接口返回內(nèi)容
將參數(shù)傳過(guò)去之后，后端返回給前端一般用JSON格式，如下所示：
(1) CODE狀態(tài)碼
code返回狀態(tài)碼，通常是在開(kāi)發(fā)按照"#1000～1999 區(qū)間表示參數(shù)錯(cuò)誤、#2000～2999 區(qū)間表示用戶錯(cuò)誤、#3000～3999 區(qū)間表示接口異常"等規(guī)則。(規(guī)則僅供參考) 例子如下所示：
(2) Message信息
Message字段相對(duì)理解比較簡(jiǎn)單，就是發(fā)生錯(cuò)誤時(shí)，如何友好的進(jìn)行提示。一般設(shè)計(jì)時(shí)和code狀態(tài)碼一一對(duì)應(yīng)，如上圖所示。
(3) data信息
返回的重要結(jié)果數(shù)據(jù)之一，下圖是完整的接口返回?cái)?shù)據(jù)。
5. 接口文檔規(guī)范
項(xiàng)目開(kāi)發(fā)需要前端和后端共同完成的，接口文檔通常由后端定義并編寫(xiě)接口文檔，然后再前后端聯(lián)調(diào)的時(shí)候，根據(jù)接口文檔進(jìn)行數(shù)據(jù)交互。
接口文檔的另一個(gè)重要作用就是規(guī)范，項(xiàng)目開(kāi)發(fā)過(guò)程中前后端工程師有一個(gè)統(tǒng)一的文件進(jìn)行溝通交流開(kāi)發(fā)，項(xiàng)目維護(hù)中或者項(xiàng)目人員更迭的時(shí)候，方便后期人員查看、維護(hù)。
接口文檔的接口分為五部分：請(qǐng)求方法(POST、GET)、接口地址、請(qǐng)求參數(shù)、返回參數(shù)、返回結(jié)果示例。以銀行卡四元素校驗(yàn)為例(https://www.juhe.cn/docs/api/id/213)：
6. 如何通過(guò)接口判斷問(wèn)題是后端還是前端造成的
PM:"前端，幫我看下這塊信息為什么是空白的。"
前端:"好勒，馬上看。"
2000 years later
前端:"我代碼沒(méi)問(wèn)題呀，參數(shù)也傳了，你問(wèn)下后端。"
PM:"后端，幫我看下這里數(shù)據(jù)為啥沒(méi)有。"
后端:"我接口沒(méi)問(wèn)題呀，等等，這數(shù)據(jù)本來(lái)就是空的，快找人新增去呀。"
后端一臉嫌棄。
很多時(shí)候，當(dāng)我們發(fā)現(xiàn)問(wèn)題的時(shí)候，第一印象就是找開(kāi)發(fā)人員詢問(wèn)原因，很多人基本不會(huì)去先判斷這問(wèn)題是屬于前端的還是后端的，導(dǎo)致溝通成本變大。
通過(guò)上面的介紹，我們可以通過(guò)接口的返回?cái)?shù)據(jù)中的狀態(tài)碼，來(lái)初步判斷問(wèn)題屬于哪一方?，F(xiàn)在介紹一下這么通過(guò)瀏覽器查看接口數(shù)據(jù)。
首先打開(kāi)任意瀏覽器(建議使用谷歌)，鼠標(biāo)右擊后點(diǎn)擊“查看”或者直接按“F12鍵”打開(kāi)發(fā)者工具，然后選擇"network"—>“XHR”，就會(huì)看到很多接口請(qǐng)求，按需找到請(qǐng)求接口，查看對(duì)應(yīng)返回?cái)?shù)據(jù)即可。
大多數(shù)情況下，可以通過(guò)接口狀態(tài)碼和消息提示去判斷是后端還是前端的問(wèn)題。
但是有些問(wèn)題比較隱蔽，即使?fàn)顟B(tài)碼返回為成功的碼，但問(wèn)題依舊存在，這種情況很有可能是后臺(tái)某細(xì)節(jié)錯(cuò)誤。
今天內(nèi)容到此結(jié)束了，點(diǎn)擊下方【閱讀原文】查看更多技術(shù)知識(shí)點(diǎn)。
熱門文章
本文為作者獨(dú)立觀點(diǎn)，不代表鳥(niǎo)哥筆記立場(chǎng)，未經(jīng)允許不得轉(zhuǎn)載。
《鳥(niǎo)哥筆記版權(quán)及免責(zé)申明》 如對(duì)文章、圖片、字體等版權(quán)有疑問(wèn)，請(qǐng)點(diǎn)擊 反饋舉報(bào)
我們致力于提供一個(gè)高質(zhì)量?jī)?nèi)容的交流平臺(tái)。為落實(shí)國(guó)家互聯(lián)網(wǎng)信息辦公室“依法管網(wǎng)、依法辦網(wǎng)、依法上網(wǎng)”的要求，為完善跟帖評(píng)論自律管理，為了保護(hù)用戶創(chuàng)造的內(nèi)容、維護(hù)開(kāi)放、真實(shí)、專業(yè)的平臺(tái)氛圍，我們團(tuán)隊(duì)將依據(jù)本公約中的條款對(duì)注冊(cè)用戶和發(fā)布在本平臺(tái)的內(nèi)容進(jìn)行管理。平臺(tái)鼓勵(lì)用戶創(chuàng)作、發(fā)布優(yōu)質(zhì)內(nèi)容，同時(shí)也將采取必要措施管理違法、侵權(quán)或有其他不良影響的網(wǎng)絡(luò)信息。
一、根據(jù)《網(wǎng)絡(luò)信息內(nèi)容生態(tài)治理規(guī)定》《中華人民共和國(guó)未成年人保護(hù)法》等法律法規(guī)，對(duì)以下違法、不良信息或存在危害的行為進(jìn)行處理。
1. 違反法律法規(guī)的信息，主要表現(xiàn)為：
1)反對(duì)憲法所確定的基本原則；
2)危害國(guó)家安全，泄露國(guó)家秘密，顛覆國(guó)家政權(quán)，破壞國(guó)家統(tǒng)一，損害國(guó)家榮譽(yù)和利益；
3)侮辱、濫用英烈形象，歪曲、丑化、褻瀆、否定英雄烈士事跡和精神，以侮辱、誹謗或者其他方式侵害英雄烈士的姓名、肖像、名譽(yù)、榮譽(yù)；
4)宣揚(yáng)恐怖主義、極端主義或者煽動(dòng)實(shí)施恐怖活動(dòng)、極端主義活動(dòng)；
5)煽動(dòng)民族仇恨、民族歧視，破壞民族團(tuán)結(jié)；
6)破壞國(guó)家宗教政策，宣揚(yáng)邪教和封建迷信；
7)散布謠言，擾亂社會(huì)秩序，破壞社會(huì)穩(wěn)定；
8)宣揚(yáng)淫穢、色情、賭博、暴力、兇殺、恐怖或者教唆犯罪；
9)煽動(dòng)非法集會(huì)、結(jié)社、游行、示威、聚眾擾亂社會(huì)秩序；
10)侮辱或者誹謗他人，侵害他人名譽(yù)、隱私和其他合法權(quán)益；
11)通過(guò)網(wǎng)絡(luò)以文字、圖片、音視頻等形式，對(duì)未成年人實(shí)施侮辱、誹謗、威脅或者惡意損害未成年人形象進(jìn)行網(wǎng)絡(luò)欺凌的；
12)危害未成年人身心健康的；
13)含有法律、行政法規(guī)禁止的其他內(nèi)容；
2. 不友善：不尊重用戶及其所貢獻(xiàn)內(nèi)容的信息或行為。主要表現(xiàn)為：
1)輕蔑：貶低、輕視他人及其勞動(dòng)成果；
2)誹謗：捏造、散布虛假事實(shí)，損害他人名譽(yù)；
3)嘲諷：以比喻、夸張、侮辱性的手法對(duì)他人或其行為進(jìn)行揭露或描述，以此來(lái)激怒他人；
4)挑釁：以不友好的方式激怒他人，意圖使對(duì)方對(duì)自己的言論作出回應(yīng)，蓄意制造事端；
5)羞辱：貶低他人的能力、行為、生理或身份特征，讓對(duì)方難堪；
6)謾罵：以不文明的語(yǔ)言對(duì)他人進(jìn)行負(fù)面評(píng)價(jià)；
7)歧視：煽動(dòng)人群歧視、地域歧視等，針對(duì)他人的民族、種族、宗教、性取向、性別、年齡、地域、生理特征等身份或者歸類的攻擊；
8)威脅：許諾以不良的后果來(lái)迫使他人服從自己的意志；
3. 發(fā)布垃圾廣告信息：以推廣曝光為目的，發(fā)布影響用戶體驗(yàn)、擾亂本網(wǎng)站秩序的內(nèi)容，或進(jìn)行相關(guān)行為。主要表現(xiàn)為：
1)多次發(fā)布包含售賣產(chǎn)品、提供服務(wù)、宣傳推廣內(nèi)容的垃圾廣告。包括但不限于以下幾種形式：
2)單個(gè)帳號(hào)多次發(fā)布包含垃圾廣告的內(nèi)容；
3)多個(gè)廣告帳號(hào)互相配合發(fā)布、傳播包含垃圾廣告的內(nèi)容；
4)多次發(fā)布包含欺騙性外鏈的內(nèi)容，如未注明的淘寶客鏈接、跳轉(zhuǎn)網(wǎng)站等，誘騙用戶點(diǎn)擊鏈接
5)發(fā)布大量包含推廣鏈接、產(chǎn)品、品牌等內(nèi)容獲取搜索引擎中的不正當(dāng)曝光；
6)購(gòu)買或出售帳號(hào)之間虛假地互動(dòng)，發(fā)布干擾網(wǎng)站秩序的推廣內(nèi)容及相關(guān)交易。
7)發(fā)布包含欺騙性的惡意營(yíng)銷內(nèi)容，如通過(guò)偽造經(jīng)歷、冒充他人等方式進(jìn)行惡意營(yíng)銷；
8)使用特殊符號(hào)、圖片等方式規(guī)避垃圾廣告內(nèi)容審核的廣告內(nèi)容。
4. 色情低俗信息，主要表現(xiàn)為：
1)包含自己或他人性經(jīng)驗(yàn)的細(xì)節(jié)描述或露骨的感受描述；
2)涉及色情段子、兩性笑話的低俗內(nèi)容；
3)配圖、頭圖中包含庸俗或挑逗性圖片的內(nèi)容；
4)帶有性暗示、性挑逗等易使人產(chǎn)生性聯(lián)想；
5)展現(xiàn)血腥、驚悚、殘忍等致人身心不適；
6)炒作緋聞、丑聞、劣跡等；
7)宣揚(yáng)低俗、庸俗、媚俗內(nèi)容。
5. 不實(shí)信息，主要表現(xiàn)為：
1)可能存在事實(shí)性錯(cuò)誤或者造謠等內(nèi)容；
2)存在事實(shí)夸大、偽造虛假經(jīng)歷等誤導(dǎo)他人的內(nèi)容；
3)偽造身份、冒充他人，通過(guò)頭像、用戶名等個(gè)人信息暗示自己具有特定身份，或與特定機(jī)構(gòu)或個(gè)人存在關(guān)聯(lián)。
6. 傳播封建迷信，主要表現(xiàn)為：
1)找人算命、測(cè)字、占卜、解夢(mèng)、化解厄運(yùn)、使用迷信方式治?。?br /> 2)求推薦算命看相大師；
3)針對(duì)具體風(fēng)水等問(wèn)題進(jìn)行求助或咨詢；
4)問(wèn)自己或他人的八字、六爻、星盤、手相、面相、五行缺失，包括通過(guò)占卜方法問(wèn)婚姻、前程、運(yùn)勢(shì)，東西寵物丟了能不能找回、取名改名等；
7. 文章標(biāo)題黨，主要表現(xiàn)為：
1)以各種夸張、獵奇、不合常理的表現(xiàn)手法等行為來(lái)誘導(dǎo)用戶；
2)內(nèi)容與標(biāo)題之間存在嚴(yán)重不實(shí)或者原意扭曲；
3)使用夸張標(biāo)題，內(nèi)容與標(biāo)題嚴(yán)重不符的。
8.「飯圈」亂象行為，主要表現(xiàn)為：
1)誘導(dǎo)未成年人應(yīng)援集資、高額消費(fèi)、投票打榜
2)粉絲互撕謾罵、拉踩引戰(zhàn)、造謠攻擊、人肉搜索、侵犯隱私
3)鼓動(dòng)「飯圈」粉絲攀比炫富、奢靡享樂(lè)等行為
4)以號(hào)召粉絲、雇用網(wǎng)絡(luò)水軍、「養(yǎng)號(hào)」形式刷量控評(píng)等行為
5)通過(guò)「蹭熱點(diǎn)」、制造話題等形式干擾輿論，影響傳播秩序
9. 其他危害行為或內(nèi)容，主要表現(xiàn)為：
1)可能引發(fā)未成年人模仿不安全行為和違反社會(huì)公德行為、誘導(dǎo)未成年人不良嗜好影響未成年人身心健康的；
2)不當(dāng)評(píng)述自然災(zāi)害、重大事故等災(zāi)難的；
3)美化、粉飾侵略戰(zhàn)爭(zhēng)行為的；
4)法律、行政法規(guī)禁止，或可能對(duì)網(wǎng)絡(luò)生態(tài)造成不良影響的其他內(nèi)容。
二、違規(guī)處罰
本網(wǎng)站通過(guò)主動(dòng)發(fā)現(xiàn)和接受用戶舉報(bào)兩種方式收集違規(guī)行為信息。所有有意的降低內(nèi)容質(zhì)量、傷害平臺(tái)氛圍及欺凌未成年人或危害未成年人身心健康的行為都是不能容忍的。
當(dāng)一個(gè)用戶發(fā)布違規(guī)內(nèi)容時(shí)，本網(wǎng)站將依據(jù)相關(guān)用戶違規(guī)情節(jié)嚴(yán)重程度，對(duì)帳號(hào)進(jìn)行禁言 1 天、7 天、15 天直至永久禁言或封停賬號(hào)的處罰。當(dāng)涉及欺凌未成年人、危害未成年人身心健康、通過(guò)作弊手段注冊(cè)、使用帳號(hào)，或者濫用多個(gè)帳號(hào)發(fā)布違規(guī)內(nèi)容時(shí)，本網(wǎng)站將加重處罰。
三、申訴
隨著平臺(tái)管理經(jīng)驗(yàn)的不斷豐富，本網(wǎng)站出于維護(hù)本網(wǎng)站氛圍和秩序的目的，將不斷完善本公約。
如果本網(wǎng)站用戶對(duì)本網(wǎng)站基于本公約規(guī)定做出的處理有異議，可以通過(guò)「建議反饋」功能向本網(wǎng)站進(jìn)行反饋。
(規(guī)則的最終解釋權(quán)歸屬本網(wǎng)站所有)