產(chǎn)品經(jīng)理應(yīng)該了解的一點(diǎn)點(diǎn)API接口知識(shí)(含文檔編寫技巧)

剛成為產(chǎn)品經(jīng)理的時(shí)候常常聽到開發(fā)吐槽:“這產(chǎn)品經(jīng)理啥都不懂软吐,這個(gè)需求那么多接口皮假,開發(fā)都?jí)騿苓€要聯(lián)調(diào),居然就排這么點(diǎn)開發(fā)時(shí)間盘寡,出了什么問題我可不負(fù)責(zé)!”每次聽到這樣的吐槽總會(huì)一臉懵逼撮慨,什么接口竿痰?什么聯(lián)調(diào)?我又做錯(cuò)了什么砌溺?

后來自己做過開發(fā)之后菇曲,開始了解到,在系統(tǒng)層面上抚吠,除了看得到的頁面功能常潮,還有很多隱藏在頁面功能之下的接口,這篇文章就簡(jiǎn)單總結(jié)一下我眼中的接口是什么樣的楷力、以及為何要學(xué)習(xí)API接口知識(shí)喊式。


什么是接口孵户?

API接口:應(yīng)用程序接口(API:Application Program Interface),是一組定義岔留、程序及協(xié)議的集合夏哭,通過 API 接口實(shí)現(xiàn)計(jì)算機(jī)軟件之間的相互通信。


打個(gè)比方献联,如果我開了一家銀行竖配,開放了存/取款的服務(wù)。普通儲(chǔ)戶通過手上的支票想取走存款里逆,必須先找到對(duì)應(yīng)的【位置】进胯,也就是正確的銀行、正確的柜臺(tái)原押。按照銀行規(guī)定的【支票格式】填寫好胁镐,那么就可以憑這個(gè)“支票”里拿走錢。另外诸衔,柜臺(tái)是有限的盯漂、來取錢的客戶可能會(huì)很多,因此也就需要客戶【取號(hào)排隊(duì)】笨农,一個(gè)接著一個(gè)有序的進(jìn)行取款服務(wù)就缆。另外,為了安全和服務(wù)質(zhì)量的考慮谒亦,銀行柜臺(tái)需要有【反饋機(jī)制】违崇,如果客戶支票填寫有誤、或者支票過期了诊霹,需要告訴客戶回去重新填寫羞延。


【位置】就是系統(tǒng)對(duì)外發(fā)布的API地址,包含了IP脾还、端口伴箩、API名稱等信息;

【支票格式】是這個(gè)接口的數(shù)據(jù)傳輸規(guī)范鄙漏,比如:SKU只支持9位長(zhǎng)度的字符串?dāng)?shù)據(jù)嗤谚,庫存只支持16位長(zhǎng)度的數(shù)字,如果傳參格式不對(duì)怔蚌,那么就會(huì)啟動(dòng)【反饋機(jī)制】巩步;

【取號(hào)排隊(duì)】就是接口的“消息隊(duì)列”,消息隊(duì)列的主要特點(diǎn)是異步處理桦踊,可以減少請(qǐng)求響應(yīng)的時(shí)間和解耦椅野。想象一下,如果取錢的人不【取號(hào)排隊(duì)】而是一哄而上涌上柜臺(tái),柜臺(tái)還能提供正常的服務(wù)嗎竟闪?

【反饋機(jī)制】就是接口中的返回參數(shù)离福,為了保證對(duì)方能夠正常獲取所有的數(shù)據(jù),不至于因?yàn)閿?shù)據(jù)異常之類的原因?qū)е聰?shù)據(jù)丟失炼蛤,在發(fā)現(xiàn)異常的時(shí)候妖爷,需要告知對(duì)方發(fā)生了什么異常,為什么無法獲取到這個(gè)數(shù)據(jù)理朋,對(duì)方就會(huì)根據(jù)這個(gè)反饋?zhàn)龀鱿鄳?yīng)的調(diào)整絮识,或者重新發(fā)起請(qǐng)求、或者放棄這種數(shù)據(jù)嗽上。

注:開發(fā)人員口中的“聯(lián)調(diào)”次舌,簡(jiǎn)而言之就是兩個(gè)系統(tǒng)的開發(fā)人員之間對(duì)這個(gè)接口調(diào)用成功與否、數(shù)據(jù)能否正常獲取等場(chǎng)景進(jìn)行測(cè)試炸裆,由于接口聯(lián)調(diào)涉及到跨系統(tǒng)的開發(fā)人員之間配合垃它,所以一般需要在正常的開發(fā)時(shí)間之外預(yù)留出一段時(shí)間給到開發(fā)人員進(jìn)行聯(lián)調(diào)鲜屏。

接口的類型有多少種烹看?

上面只是用一個(gè)比較通俗的例子對(duì)接口的原理進(jìn)行說明,實(shí)際上接口的類型有很多洛史,下面會(huì)根據(jù)不同的接口類型講講各種類型接口之間的區(qū)別:

一惯殊、根據(jù)響應(yīng)的機(jī)制可以分為同步、異步接口:

同步接口:A系統(tǒng)請(qǐng)求B系統(tǒng)接口之后也殖,必須獲得B系統(tǒng)接口的響應(yīng)后才會(huì)執(zhí)行下一步操作土思;

例如:登錄操作的時(shí)候調(diào)用第三方平臺(tái)接口(如微信)進(jìn)行登錄,需要跳轉(zhuǎn)到微信進(jìn)行驗(yàn)證并返回驗(yàn)證結(jié)果后忆嗜,才能登錄成功己儒;

異步接口:A系統(tǒng)請(qǐng)求B系統(tǒng)接口之后,不需要等待源系統(tǒng)返回結(jié)果就可以進(jìn)行下一步操作捆毫;

例如:在滴滴打車之后闪湾,司機(jī)點(diǎn)擊結(jié)束行程后,不需要等待銀行付款成功之后再開始下一個(gè)訂單绩卤。因?yàn)榇藭r(shí)滴滴已經(jīng)驗(yàn)證過司機(jī)途样、乘客的銀行賬戶或者支付寶賬戶,確認(rèn)了雙方交易的合法性就可以結(jié)束訂單濒憋。這時(shí)我們看到的是我們已經(jīng)付款成功(其實(shí)銀行可能還沒扣款)何暇,而滴滴后臺(tái)會(huì)將這筆交易流水傳給銀行,在銀行驗(yàn)證后再進(jìn)行扣款凛驮、付款操作裆站。

二、根據(jù)接口的觸發(fā)形式可以分為分發(fā)、訂閱接口:

分發(fā)接口:A系統(tǒng)產(chǎn)生新數(shù)據(jù)的時(shí)候就分發(fā)給B系統(tǒng)(也可以是多個(gè))遏插;

例如:電商網(wǎng)站后臺(tái)的客戶管理系統(tǒng)捂贿,在產(chǎn)生了一個(gè)新的黑名單客戶的時(shí)候,就會(huì)將數(shù)據(jù)分發(fā)到訂單胳嘲、推薦等等各個(gè)系統(tǒng)厂僧,以便及時(shí)攔截這部分客戶的訂單;

訂閱接口:B系統(tǒng)在需要的時(shí)候調(diào)用A系統(tǒng)的接口進(jìn)行數(shù)據(jù)訂閱了牛;

例如:用戶在股票交易軟件中查詢銀行賬戶余額的時(shí)候才會(huì)調(diào)用銀行的余額查詢接口颜屠,而股票交易軟件自身不存儲(chǔ)這個(gè)數(shù)據(jù);

產(chǎn)品經(jīng)理了解接口有什么用鹰祸?

以上不同類型的接口分別有不同的使用場(chǎng)景甫窟,個(gè)人認(rèn)為產(chǎn)品經(jīng)理不需要理解各種接口的實(shí)現(xiàn)原理,但是要了解什么場(chǎng)景應(yīng)該使用什么樣的接口蛙婴,以便更好地對(duì)外提供數(shù)據(jù)服務(wù)粗井。個(gè)人看來,了解接口有以下幾個(gè)好處:

①明確各個(gè)系統(tǒng)之間的數(shù)據(jù)流轉(zhuǎn)街图,特別是功能系統(tǒng)的產(chǎn)品經(jīng)理浇衬,只有在知道了功能設(shè)計(jì)的目的、需要對(duì)外提供什么樣的接口服務(wù)餐济,需求設(shè)計(jì)階段才能夠考慮得更加全面耘擂;

②掌握開發(fā)總體工作量,而不局限于功能絮姆;另外醉冤,在安排項(xiàng)目計(jì)劃時(shí)能夠考慮到與周邊系統(tǒng)聯(lián)調(diào)的時(shí)間,計(jì)劃安排才會(huì)更加合理篙悯;

③識(shí)別項(xiàng)目中的關(guān)鍵風(fēng)險(xiǎn)點(diǎn)蚁阳,特別是一些關(guān)鍵接口、數(shù)據(jù)量大需要進(jìn)行大數(shù)據(jù)壓測(cè)的接口,需要盡早安排聯(lián)調(diào)和測(cè)試,并且對(duì)周邊配合的項(xiàng)目提出要求入挣;

產(chǎn)品經(jīng)理如何寫接口文檔?

在度娘就可以找到不少現(xiàn)成的接口文檔归粉,可以參考騰訊開放平臺(tái)上的API列表http://wiki.open.qq.com/wiki/API%E5%88%97%E8%A1%A8,這里簡(jiǎn)單總結(jié)幾個(gè)要點(diǎn):


1漏峰、聲明接口字段和返回參數(shù)糠悼,字段需要聲明是否必填、字段類型浅乔、長(zhǎng)度以及處理規(guī)則倔喂;

2铝条、聲明接口預(yù)估的數(shù)據(jù)量大小、調(diào)用頻率等席噩,以保證開發(fā)時(shí)考慮到接口的健壯性班缰;

3、聲明接口的異常處理方式悼枢,如失敗的數(shù)據(jù)是否重發(fā)埠忘、重發(fā)次數(shù)等等;

注:在之前的產(chǎn)品設(shè)計(jì)過程中馒索,還出現(xiàn)過配合系統(tǒng)雙方的產(chǎn)品經(jīng)理為了誰應(yīng)該來寫接口文檔而爭(zhēng)執(zhí)過莹妒,后來定了一套標(biāo)準(zhǔn),個(gè)人認(rèn)為是比較合理的绰上,供大家參考:

原則1:一般是由數(shù)據(jù)的需求方來編寫接口需求文檔旨怠;

原則2:如果該接口是一個(gè)分發(fā)接口,則由數(shù)據(jù)的提供方來編寫接口需求文檔蜈块;

總結(jié):

好了鉴腻,說到這里,已經(jīng)把我個(gè)人這些年工作中所接觸到的API接口簡(jiǎn)單介紹了一下百揭,由于本人一直是做后端產(chǎn)品經(jīng)理爽哎,因此對(duì)于前端的接口涉獵不多,不了解差異有多大信峻,以上內(nèi)容僅供后端產(chǎn)品經(jīng)理參考倦青,也希望大家能夠?qū)ξ闹械囊恍╁e(cuò)誤及時(shí)指正瓮床。

另外盹舞,作為一名大數(shù)據(jù)的產(chǎn)品經(jīng)理,大數(shù)據(jù)如何利用接口對(duì)外提供服務(wù)隘庄?后續(xù)總結(jié)出自己的一套方法論后再跟分享踢步。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市丑掺,隨后出現(xiàn)的幾起案子获印,更是在濱河造成了極大的恐慌,老刑警劉巖街州,帶你破解...
    沈念sama閱讀 206,214評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件兼丰,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡唆缴,警方通過查閱死者的電腦和手機(jī)鳍征,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來面徽,“玉大人艳丛,你說我怎么就攤上這事匣掸。” “怎么了氮双?”我有些...
    開封第一講書人閱讀 152,543評(píng)論 0 341
  • 文/不壞的土叔 我叫張陵碰酝,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我戴差,道長(zhǎng)送爸,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,221評(píng)論 1 279
  • 正文 為了忘掉前任暖释,我火速辦了婚禮碱璃,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘饭入。我一直安慰自己嵌器,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,224評(píng)論 5 371
  • 文/花漫 我一把揭開白布谐丢。 她就那樣靜靜地躺著爽航,像睡著了一般。 火紅的嫁衣襯著肌膚如雪乾忱。 梳的紋絲不亂的頭發(fā)上讥珍,一...
    開封第一講書人閱讀 49,007評(píng)論 1 284
  • 那天,我揣著相機(jī)與錄音窄瘟,去河邊找鬼衷佃。 笑死,一個(gè)胖子當(dāng)著我的面吹牛蹄葱,可吹牛的內(nèi)容都是我干的氏义。 我是一名探鬼主播,決...
    沈念sama閱讀 38,313評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼图云,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼惯悠!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起竣况,我...
    開封第一講書人閱讀 36,956評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤克婶,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后丹泉,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體情萤,經(jīng)...
    沈念sama閱讀 43,441評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,925評(píng)論 2 323
  • 正文 我和宋清朗相戀三年摹恨,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了筋岛。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,018評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡睬塌,死狀恐怖泉蝌,靈堂內(nèi)的尸體忽然破棺而出歇万,到底是詐尸還是另有隱情,我是刑警寧澤勋陪,帶...
    沈念sama閱讀 33,685評(píng)論 4 322
  • 正文 年R本政府宣布贪磺,位于F島的核電站,受9級(jí)特大地震影響诅愚,放射性物質(zhì)發(fā)生泄漏寒锚。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,234評(píng)論 3 307
  • 文/蒙蒙 一违孝、第九天 我趴在偏房一處隱蔽的房頂上張望刹前。 院中可真熱鬧,春花似錦雌桑、人聲如沸喇喉。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽拣技。三九已至,卻和暖如春耍目,著一層夾襖步出監(jiān)牢的瞬間膏斤,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評(píng)論 1 261
  • 我被黑心中介騙來泰國(guó)打工邪驮, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留莫辨,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,467評(píng)論 2 352
  • 正文 我出身青樓毅访,卻偏偏與公主長(zhǎng)得像沮榜,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子俺抽,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,762評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容

  • 每天進(jìn)步一點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)點(diǎn)~~從開始只能寫幾句話敞映、模仿別人的觀點(diǎn)较曼,到現(xiàn)...
    一個(gè)帥氣的名字呀閱讀 18,046評(píng)論 4 31
  • 去年有段時(shí)間得空磷斧,就把谷歌GAE的API權(quán)威指南看了一遍,收獲頗豐捷犹,特別是在自己幾乎獨(dú)立開發(fā)了公司的云數(shù)據(jù)中心之后...
    騎單車的勛爵閱讀 20,438評(píng)論 0 41
  • 我在火車上的時(shí)候弛饭,就特別想給你寫情書。 也許是因?yàn)檫@種感覺很像我去杭州萍歉,讓我條件反射般的開心侣颂。 每一次來杭州的八個(gè)...
    深井冰4353閱讀 127評(píng)論 0 0
  • 那年 盛夏 再也回不去那樣美好單純的日子 那個(gè)夕陽仍燦爛的傍晚 那個(gè)眉目清朗的少年 在少女臉頰上印上輕輕一吻 仿佛...
    懷舊閱讀 212評(píng)論 0 2
  • 每日精選笑話:投資跟投機(jī)的區(qū)別 ? 老師:投資跟投機(jī)有什么區(qū)別憔晒? 小明:一個(gè)是普通話藻肄,一個(gè)是廣東話! 老師:就你知...
    火鍋家族閱讀 266評(píng)論 0 7