產品經理如何閱讀API文檔

數十萬互聯網從業者的共同關注！

作者：壹叔

編輯：Verna

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

很多人也許要問了，產品經理一定要讀開發文檔么，這個不是技術童鞋要做的事情么？客觀地來說，大多數時候你要是基於自己的平台去開發產品，那麼是不需要在開發文檔上花費多少心思的；但作為一個第三方平台的產品經理（尤其如微信、支付寶等），閱讀平台的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文檔，是非常有必要的一件事情。無論是從產品設計的角度，還是對於和開發的溝通協調，以及產品經理自身修養的提高等，都會有不少的幫助，可以讓你從更高的緯度去俯視整個產品。

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

Read More

本文由作者授權早讀課發表，轉載請聯繫作者。

優秀人才不缺工作機會，只缺適合自己的好機會。但是他們往往沒有精力從海量機會中找到最適合的那個。

100offer 會對平台上的人才和企業進行嚴格篩選，讓「最好的人才」和「最好的公司」相遇。

點擊展開全文

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！