很多產品經理剛接觸 API 介面文件的時候，腦子一片空白，不理解介面（API）是什麼，更看不懂介面開發文件。那麼，作為一個不懂技術的產品經理，該如何看懂介面文件。今天這篇文章就跟大家好好巴拉巴拉。

什麼是API介面

在專案開發中，web專案的前後端是分離開發的。應用程式的開發，需要由前後端工程師共同定義介面，編寫介面文件，之後大家都根據這個介面文件進行開發，到專案結束前都要一直維護。

為什麼有API介面文件

1）專案開發過程中前後端工程師有一個統一的檔案進行溝通交流開發

2）專案維護中或者專案人員更迭的時候，方便後期人員檢視、維護

怎麼看懂API文件

API 介面文件一般分為介面描述、介面地址、請求方法、請求引數、相應內容、錯誤程式碼、例項幾個部分。

1、介面描述：簡單描述介面的邏輯和作用

2、介面地址：介面的正式 url 和介面測試的 url，需求方透過呼叫介面 url，獲取響應內容

3、請求方法：一般來說，介面最常見的請求方法為 GET 和 POST 兩種方式，即讀介面和寫介面。透過這兩種方式，實現對資料的增刪查改。增刪改本質都是寫的動作。

4、請求引數：即需要請求的欄位名的名稱和規則：都是哪些欄位，欄位的型別是什麼，是否必填欄位等等

5、響應內容：介面返回的欄位名稱和規則。注意：大部分開發往往不會把所有的欄位羅列，只會列出比較重要的欄位。當你發現，介面文件中沒有你需求的欄位，彆著急找開發，可以看下例項中，有沒有需求的欄位。

6、錯誤程式碼：對介面的錯誤用程式碼進行歸類，以便能快速找到錯誤原因，解決問題。

7、例項實際：呼叫時的響應的內容。

API介面是什麼？產品經理怎麼去看API介面文件？

相關文章