接口文檔怎麼看？其實公司大多數用的都是内部接口，第三方接口其實相比起來用得少，兩者區别隻是提供方不一樣。

接口文檔其實就是一個講解某個接口是做什麼的文件。不管是你們公司内部的開發，或者是你跟一些第三方合作的時候，産品經理必須要知道怎麼看接口文檔，知道裡面哪些部分是重要的才行。

否則别說功能實現，溝通都很難進行……

懂點基礎知識好溝通

比方說，你們公司要做一個考勤系統，想用人臉識别來進行打卡，但是人臉識别這個事可能有點技術難度，我們就決定用第三方了。

找到第三方，第三方可能會丢你一個接口文檔讓你自己看去

這時你就要通過看文檔了解這個接口提供哪些功能，你需要用到哪些，你的哪些想法是他的接口能滿足的，哪些是不能滿足的。

比方說，現在有一種情況，大家現在經常戴口罩或者是戴墨鏡什麼的。這個api接口提供的人臉識别的打卡功能裡面，人戴上的這種戴上眼睛之後，能不能進行打卡，就需要在他的文檔裡面去找到，看是否有相應能力。

研發也是要寫很多東西的~比如接口文檔

先介紹幾個概念：

請求參數

比方說你需要讓阿裡雲給你發一條短信，你至少需要告訴他你要發送到哪個手機上面去，對吧？這個手機号碼就是請求參數。在請求接口的時候，需要把這個請求參數給他。

請求參數跟設計功能很相關的，必須在産品設計的時候考慮如何這些請求參數，檢查接口文檔的時候也要重點留心各種請求參數是不是都寫全了。

跟請求參數相對應的是返回參數

請求做完了之後，它要告訴你他有沒有發送成功，成功了就返回查詢的信息，失敗的就報錯。比如說你是一個查詢訂單詳情的，或者查詢一個商品頁，接口就需要把商品查詢出來商品的關鍵信息之類的返回給你，這個就是返回參數。一般在工作中關注“返回參數”比較多。

這時一般都會返回多個字段，但是我們在接口文檔裡面就需要知道它字段代表什麼意思，比如參數名是什麼，類型是什麼；如果出現錯誤的話，它會有一些錯誤碼給你。比方說你在下一個微信支付訂單的時候，前端在調用的時候就返回了一個403的一個錯誤，然後這個時候對照接口文檔一看你就知道403代表什麼意思了。

接口文檔可以是word、txt等等，形式不重要，關鍵是文檔裡面最關鍵的7個步驟需要好好了解一下：

1.接口描述：簡述接口是幹什麼的

2.接口地址是什麼？

接口暴露出去給别人用，一定是有一個地址的。一定要知道請求地址是什麼，這也就是請求的URL是什麼。

3.調用時的方法類型是什麼

是pose的還是get，都會在這個文章裡面描述好。

post的和get的區别是什麼？在get請求傳輸的時候，URL地址會在網址的後面附加上去，也就是說網址上會有請求參數，并且get請求的參數是有長度限制的；post請求的參數就不會在URL裡面展示出來。

4&5.請求參數、返回參數

6.返回結果

7.錯誤代碼

【怼研發環節】

跟研發提需求的時候，研發可能直接告訴你不行，這個需求做不了，是不是？這個時候你可以告訴他，某某某的接口裡面提供這個功能，我們就需要調用它的接口就可以了，然後你把接口給他，就可以了。

使用ApiPost工具可以實現調用接口，知道這個接口它是否是正常的，還有這個接口返回的數據和傳入的參數是什麼。

apipost = API接口調試工具 接口文檔管理工具 Mock 工具

其實我們使用第三方接口的時候，開發人員其實不是直接用第三方接口的，而是先由服務端的人員把第三方的接口進行了封裝之後再提供出來的。

我最近是要上線一個輸入電話号碼發送短信的功能，這個功能就需要考慮到接口要進行請求次數的限制，否則可能有的人會無聊地不停的請求發送短信，可能很快公司短信這一塊的經費就消耗完了……

更多精彩资讯请关注tft每日頭條，我们将持续为您更新最新资讯!