erp項目或者其他開發(fā)項目，或多或少都會接觸到關(guān)于接口的任務(wù)，可能是編寫接口api文檔，也可能是調(diào)用接口。無論是寫或者用，都避免不了要讀懂了解接口文檔的組成。
1.接口文檔是什么
在項目開發(fā)匯總，web項目的前后端是分離開發(fā)的。應(yīng)用程序的開發(fā)，需要由前后端工程師共同定義接口，編寫接口文檔，之后大家都根據(jù)這個接口文檔進行開發(fā)，到項目結(jié)束前都要一直維護。
2.為什么要寫接口文檔？
1）項目開發(fā)過程中前后端工程師有一個統(tǒng)一的文件進行溝通交流開發(fā)
2）項目維護中或者項目人員更迭的時候，方便后期人員查看、維護
3.回顧接口的知識
要了解接口文檔的規(guī)范，首先要了解接口。接口分為四部分：請求方法、url、請求參數(shù)、返回參數(shù)：
1）方法：常用的方法就是下面的四種：GET PUT POST DELETE
2）url：以/a開頭，如果需要登錄才能調(diào)用的接口（如新增、修改；前臺的用戶個人信息，資金信息等）后面需要加/u，即：/a/u；中間一般放表名或者能表達這個接口的單詞。get方法，若果是后臺通過搜索查詢列表，那么以/search結(jié)尾，如果是前臺的查詢列表，以/list結(jié)尾。uri地址里不遜于出現(xiàn)大寫字母，如果是兩個單詞拼接，用/分開
3）請求參數(shù)和返回參數(shù)：請求參數(shù)和返回參數(shù)都分為：字段、說明、類型、備注、是否必填這5列。
字段：類的屬性
說明：中文釋義
類型：屬性的類型，只有String、Number、Object、Array四大類
備注：一些解釋語，或者寫簡單的示例
4）返回參數(shù)，要分兩種情況討論：
只返回接口調(diào)用成功或者失?。篶ode、reason
返回參數(shù)：字段、類型
3.常見問題
一份規(guī)范的接口文檔應(yīng)該包括什么內(nèi)容
4.解決方案
除了上面提到的請求方法、url、請求參數(shù)、返回參數(shù)以外，還應(yīng)該添加接口示例、接口文檔版本號、版本修改內(nèi)容、版本修改時間、修改人，錯誤代碼等。
5.示例：
下面是在網(wǎng)站上找到的一個接口文檔示例
