產品經理如何閱讀API文檔

最近在公司內部負責兩個微信小程序項目,于是將許久沒有接觸的開發文檔閱讀工作又撿了起來。

很多人也許要問了,產品經理一定要讀開發文檔么,這個不是技術童鞋要做的事情么?客觀地來說,大多數時候你要是基于自己的平臺去開發產品,那么是不需要在開發文檔上花費多少心思的;但作為一個第三方平臺的產品經理(尤其如微信、支付寶等),閱讀平臺的API文檔,則是相當有必要的,也可以說是產品基本功吧。

那么,產品經理究竟該如何來閱讀API文檔呢?

什么是API

API,全稱是Application Programming Interface,即應用程序編程接口,我們日常中習慣簡稱為“接口”。其實,接口這個詞大家應該不會陌生,比如我們平時比較常用的“USB接口”,就是用來存儲和傳輸數據用的;那什么是API呢,API事實上是在內部預先定義了函數,能夠使開發人員無須明白API內部實現的機制,就能夠實現某一個功能。

比如說你要實現一個手機注冊的功能,那么相應地后臺工程師就需要提供一個手機注冊的接口,前端開發人員在調用接口實現功能的時候,只需按照既定的規則進行請求即可,不需要去理解該功能的實現邏輯。有了這么一個機制,就使得開發人員間的協作變得非常簡潔、高效。

所以,你可以簡單地理解為“接口決定了功能”。

那API究竟是用來干嘛的呢?我的理解是,API其實是大自然的搬運工。如何理解這個“搬運工”的概念,其實就是指搬運互聯網數據,因為API的本質就是根據調用者的輸入內容來返回一些其他內容,不就相當于把數據搬來搬去么(這個搬運工的比喻是不是很形象)。

API文檔的結構

通常來說,一份API文檔內會包含多個API的信息,單個API的信息通常包括以下內容:

1、接口描述:這個接口是用來干嘛的,以及相關的規則

2、接口地址:以網址的形式展現,你通過發送請求給這個網址來對接口進行交互操作

3、請求方法:常用的有post和get兩種方式,一個是讀接口(常用get)一個是寫接口(常用post)

4、請求參數:請求該接口時,需要提供的參數,參數屬性包括名稱、類型、是否必填、描述等

5、返回參數:接口正常響應后,返回的內容

6、錯誤代碼:接口請求失敗后,返回的錯誤代碼

小程序開發文檔

閱讀API文檔的好處

這個恐怕是大多數產品童鞋的疑惑,就是產品經理去閱讀開發文檔,究竟收益在哪里?從我個人的經驗出發,也許會有這么幾點收益:

1、對技術理解更深刻,讓產品更有想象力

試想這么一個場景,如果你是小程序的PM,但是又不去閱讀開發文檔,可能帶來的悲劇結果就是,微信開放了許多小程序的最新能力,但是你卻不知道如何應用到你自己的產品中去;或者,即使知道大概有那么一回事,卻不清楚具體可以做的操作細節有哪些,在自身產品中的應用場景在哪里,而往往產品細節和場景又是那么地重要。拿我自己實操的一個案例來說,就是因為當時沒有閱讀開發文檔,所以誤以為不能獲取微信群的名稱,只能獲取到微信群的id,導致最后在產品設計的時候沒有給用戶更好的綁定群信息感知的體驗。

說的直白一點,沒有新技術就沒有新的想象力(別問我想象力是什么)。

2、更好地預估開發工作量

長時間閱讀API文檔,可以對接口有更加深刻的認識,那么在和開發評估開發工作量的過程中,也是有幫助的。因為很多時候,產品和開發對新舊的理解不同,所以會造成這樣一種現象:新的功能不一定需要新的API,相似的功能可能需要重新做一個新的API。如果產品經理在熟悉了開發文檔之后,就能大幅減少這種情況的發生,評估一個新的功能開發工作量的時候,不會僅僅站在產品設計的角度(這兩個功能不是差不多么,所以基于之前的接口應該很快就能上線吧),還會站在開發的角度(噢,這里的確要兩個接口來實現),這樣也更有利于產品和開發童鞋的和平共處。

3、鍛煉產品抽象能力

事實上,接口本身就是個非常抽象的事物,大概在很久很久以前,有一個人跟我說過一句話,接口都是可以抽象起來進行復用的,但是前端卻是千變萬化的。嗯,其實一個厲害的產品經理,如果真的非常熟悉接口的話,他是可以做到像搭建樂高積木一樣,來通過現有的接口搭建產品的。聽說在騰訊內部,騰訊會將大系統盡量拆分成功能單一的模塊,在架構上盡量使用插件式的設計,高度解耦,并且會將業務邏輯服務化,比如將搖一搖、漂流瓶等都做成服務,供微信、QQ等開發團隊調用,這里調用的就是API。

總結

總的來說,對于第三方平臺的產品經理,熟悉官方API文檔,是非常有必要的一件事情。無論是從產品設計的角度,還是對于和開發的溝通協調,以及產品經理自身修養的提高等,都會有不少的幫助,可以讓你從更高的緯度去俯視整個產品。

也許,站的更高,真的能看的更遠呢。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,882評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,208評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,746評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,666評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,477評論 6 407
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,960評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,047評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,200評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,726評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,617評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,807評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,327評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,049評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,425評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,674評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,432評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,769評論 2 372

推薦閱讀更多精彩內容