不懂技術如何看懂API接口文檔?產品經理們是這麼做的

不懂技術如何看懂API接口文檔?產品經理們是這麼做的

很多產品經理剛接觸API接口工作時,腦子一片空白,不理解接口(API)是什麼,更看不懂接口開發文檔,在接口上踩了很多坑。作為一個踩坑踩到步步高昇的資深產品經理,我決定來分享一下我的多年經驗:作為一個不懂技術的產品經理,該如何看懂接口文檔。

不懂技術如何看懂API接口文檔?產品經理們是這麼做的

API是什麼

API就好像是一個傳輸數據的通道,入口需要請求數據,相當於通關密碼,而出口需要返回結果。接口的使用方不需要關心接口是如何實現的,只關心能不能拿到接口最後的返回結果。接口的提供方需要定義接口請求參數、響應內容等,還需要關注接口的性能,是否能滿足高併發的調用,接口的穩定性如何……總之,API就是一個預先定義的函數。
不懂技术如何看懂API接口文档?产品经理们是这么做的

API文檔

API接口一般分為接口描述、接口地址、請求方法、請求參數、相應內容、錯誤代碼、實例幾個部分。

1、接口描述

簡單描述接口的邏輯和作用

2、接口地址

接口的正式url和接口測試的url,需求方通過調用接口url,獲取響應內容

3、請求方法

一般來說,接口最常見的請求方法為GET和POST兩種方式,即讀接口和寫接口。通過這兩種方式,實現對數據的增刪查改。增刪改本質都是寫的動作。

4、請求參數

即需要請求的字段名的名稱和規則:都是哪些字段,字段的類型是什麼,是否必填字段等等

5、響應內容

接口返回的字段名稱和規則。

注意:大部分開發往往不會把所有的字段羅列,只會列出比較重要的字段。當你發現,接口文檔中沒有你需求的字段,彆著急找開發,可以看下實例中,有沒有需求的字段。


6、錯誤代碼

對接口的錯誤用代碼進行歸類,以便能快速找到錯誤原因,解決問題。

7、實例

實際調用時的響應的內容。做產品經理是難的,因為要懂得的東西太多了,而做產品經理也是容易的,因為有些東西根本不需要精通,只要略懂就可以了,基本上你能把以上幾個部分搞明白,看懂一個API文檔是沒有問題的,和技術人員對接的時候也不會再被吐槽是個傻逼。總之,產品經理做得好就風風光光,做不好會人人喊打,根本就是條不歸路,而我已經在這條路上越走越遠……


分享到:


相關文章: