接口文檔怎么看？其實公司大多數(shù)用的都是內(nèi)部接口，第三方接口其實相比起來用得少，兩者區(qū)別只是提供方不一樣。

接口文檔其實就是一個講解某個接口是做什么的文件。不管是你們公司內(nèi)部的開發(fā)，或者是你跟一些第三方合作的時候，產(chǎn)品經(jīng)理必須要知道怎么看接口文檔，知道里面哪些部分是重要的才行。

否則別說功能實現(xiàn)，溝通都很難進行……

懂點基礎(chǔ)知識好溝通

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

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

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

比方說，現(xiàn)在有一種情況，大家現(xiàn)在經(jīng)常戴口罩或者是戴墨鏡什么的。這個api接口提供的人臉識別的打卡功能里面，人戴上的這種戴上眼睛之后，能不能進行打卡，就需要在他的文檔里面去找到，看是否有相應(yīng)能力。

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

先介紹幾個概念：

請求參數(shù)

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

請求參數(shù)跟設(shè)計功能很相關(guān)的，必須在產(chǎn)品設(shè)計的時候考慮如何這些請求參數(shù)，檢查接口文檔的時候也要重點留心各種請求參數(shù)是不是都寫全了。

跟請求參數(shù)相對應(yīng)的是返回參數(shù)

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

這時一般都會返回多個字段，但是我們在接口文檔里面就需要知道它字段代表什么意思，比如參數(shù)名是什么，類型是什么；如果出現(xiàn)錯誤的話，它會有一些錯誤碼給你。比方說你在下一個微信支付訂單的時候，前端在調(diào)用的時候就返回了一個403的一個錯誤，然后這個時候?qū)φ战涌谖臋n一看你就知道403代表什么意思了。

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

1.接口描述：簡述接口是干什么的

2.接口地址是什么？

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

3.調(diào)用時的方法類型是什么

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

post的和get的區(qū)別是什么？在get請求傳輸?shù)臅r候，URL地址會在網(wǎng)址的后面附加上去，也就是說網(wǎng)址上會有請求參數(shù)，并且get請求的參數(shù)是有長度限制的；post請求的參數(shù)就不會在URL里面展示出來。

4&5.請求參數(shù)、返回參數(shù)

6.返回結(jié)果

7.錯誤代碼

【懟研發(fā)環(huán)節(jié)】

跟研發(fā)提需求的時候，研發(fā)可能直接告訴你不行，這個需求做不了，是不是？這個時候你可以告訴他，某某某的接口里面提供這個功能，我們就需要調(diào)用它的接口就可以了，然后你把接口給他，就可以了。

使用ApiPost工具可以實現(xiàn)調(diào)用接口，知道這個接口它是否是正常的，還有這個接口返回的數(shù)據(jù)和傳入的參數(shù)是什么。

apipost = API接口調(diào)試工具 + 接口文檔管理工具 + Mock 工具

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

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