多年的IT經(jīng)驗(yàn)告訴你：不合理，而且會(huì)造成工期的延誤，不利于整體項(xiàng)目的推進(jìn)。

接口

它是基于超文本傳輸協(xié)議（HTTP）之上而確定的一組約束和屬性，是一種設(shè)計(jì)提供萬維網(wǎng)絡(luò)服務(wù)的軟件構(gòu)建風(fēng)格。

符合或兼容于這種架構(gòu)風(fēng)格的網(wǎng)絡(luò)服務(wù)，允許客戶端發(fā)出以統(tǒng)一資源標(biāo)識(shí)符訪問和操作網(wǎng)絡(luò)資源的請(qǐng)求，而與預(yù)先定義好的無狀態(tài)操作集一致化。

接口文檔

在項(xiàng)目開發(fā)中，web項(xiàng)目的前后端分離開發(fā)源碼，APP開發(fā)，需要由前后端工程師共同定義接口，編寫接口文檔，之后大家都根據(jù)這個(gè)接口文檔進(jìn)行開發(fā)，到項(xiàng)目結(jié)束前都要一直維護(hù)。

為啥要提前提供接口規(guī)范文檔

因?yàn)轫?xiàng)目初期，需求確定后就要進(jìn)行開發(fā)。而在開發(fā)過程中，都是團(tuán)隊(duì)協(xié)作。每個(gè)人不是孤軍奮戰(zhàn)，尤其在前后端分離的項(xiàng)目電銷外呼程序上接口規(guī)范文檔尤其重要。

這里簡(jiǎn)單說下一個(gè)概念：前后端分離，就是前臺(tái)負(fù)責(zé)做頁面，調(diào)用后臺(tái)的接口服務(wù)獲取數(shù)據(jù)，然后渲染頁面，呈現(xiàn)給用戶。后端需要提供接口能力，保證功能穩(wěn)定性。

在實(shí)際過程，前端開發(fā)設(shè)計(jì)需要時(shí)間，而后端開發(fā)接口也同樣需要時(shí)間，所以先提供接口規(guī)范有利于前端根據(jù)接口規(guī)范，模擬返回?cái)?shù)據(jù)源碼，進(jìn)行模擬測(cè)試。而后臺(tái)在這段時(shí)間也可以開發(fā)接口服務(wù)，等到按照預(yù)期的聯(lián)調(diào)時(shí)間，就可以前后臺(tái)進(jìn)行正式聯(lián)調(diào)。

為啥需要正式聯(lián)調(diào)，因?yàn)榻涌谝?guī)范可能會(huì)在實(shí)際開發(fā)過程中發(fā)生變動(dòng)，前端第一次根據(jù)后臺(tái)的接口規(guī)范構(gòu)造的模擬數(shù)據(jù)，不足以證明后期的實(shí)際聯(lián)調(diào)沒問題。

在正式聯(lián)調(diào)后，確定最終的接口規(guī)范文檔，對(duì)外發(fā)布。

合格的接口規(guī)范文檔

明確定義接口的名字、作用。這樣有利于讀者對(duì)接口所涉及的業(yè)務(wù)功能有清晰的概念。定義接口的URL地址。定義接口的請(qǐng)求方式，如GET請(qǐng)求、POST請(qǐng)求。定義接口請(qǐng)求的Header頭部信息，比如定義"Content-Type": "application/json;charset=UTF-8"。定義接口的參數(shù)字段名、字段類型、是否必填、說明字段的意義、備注（可選）。定義接口返回的狀態(tài)碼，比如常見的200 OK。定義接口返回的的Header頭部信息。定義接口返回的響應(yīng)結(jié)果。（可選）提供接口返回的請(qǐng)求例子、響應(yīng)結(jié)果例子。

團(tuán)隊(duì)合作，文檔先行，編碼在后，這樣有利于整體項(xiàng)目如期完成。

希望該回答，可以幫助到你。