怎么看待一些后端程序員不寫(xiě)接口文檔，老是以很忙為借口搪塞？不寫(xiě)接口文檔，一般很忙?；蛘邲](méi)有時(shí)間整理文件。對(duì)于前端和后端的對(duì)接，前端開(kāi)發(fā)人員一般需要后端人員提供接口文檔，而現(xiàn)在招搖過(guò)市的文檔完全可以提供

怎么看待一些后端程序員不寫(xiě)接口文檔，老是以很忙為借口搪塞？

不寫(xiě)接口文檔，一般很忙?；蛘邲](méi)有時(shí)間整理文件。

對(duì)于前端和后端的對(duì)接，前端開(kāi)發(fā)人員一般需要后端人員提供接口文檔，而現(xiàn)在招搖過(guò)市的文檔完全可以提供這個(gè)功能。在許多情況下，后端開(kāi)發(fā)人員集成了一個(gè)swagger并自動(dòng)生成相應(yīng)的文檔。

您可以給后端開(kāi)發(fā)人員一定的時(shí)間來(lái)學(xué)習(xí)swagger或?qū)wagger集成到項(xiàng)目中。

如何正確規(guī)范寫(xiě)接口文檔？

編寫(xiě)文檔，無(wú)論是接口文檔還是需求文檔。關(guān)鍵是雙方都需要能夠在第一時(shí)間理解并達(dá)成共識(shí)，這是一個(gè)好的文件。

對(duì)接口文檔有幾點(diǎn)建議：1。前提條件應(yīng)該明確定義

前提條件包括接口環(huán)境、項(xiàng)目版本號(hào)等，因?yàn)樵S多公司同時(shí)運(yùn)行多個(gè)版本。在不注意前提的情況下，很容易出現(xiàn)一些讓人歡笑的事情。測(cè)試過(guò)程中有很多問(wèn)題。結(jié)果發(fā)現(xiàn)前端環(huán)境或者版本號(hào)是錯(cuò)誤的，浪費(fèi)了很多時(shí)間，沒(méi)有意義。

2. 需要定義一般退貨編碼

一般退貨編碼包括一般成功、一般異常等，此類(lèi)一般退貨內(nèi)容可以定義一次，以下關(guān)于業(yè)務(wù)處理的退貨編碼可以省略，不能寫(xiě)入這些內(nèi)容；

3。必須給出參數(shù)傳遞和返回的例子

例子可以很好的避免一些不必要的問(wèn)題，一個(gè)好的接口文檔可能就是一些例子。節(jié)省時(shí)間和精力。

后端開(kāi)發(fā)完接口才給出接口文檔，合理嗎？你怎么看？

一個(gè)非常好的問(wèn)題。我是一個(gè)web應(yīng)用程序架構(gòu)師，多年來(lái)一直致力于回答這個(gè)問(wèn)題。歡迎跟我來(lái)了解更多。

后端提供接口文檔為時(shí)已晚，這是合理和不合理的。根據(jù)具體情況，總有解決辦法。讓我談?wù)勎业挠^(guān)點(diǎn)。

不合理：成熟的技術(shù)團(tuán)隊(duì)重視功能設(shè)計(jì)，在編寫(xiě)代碼之前有完整的技術(shù)文檔和功能定義。即使在TDD測(cè)試驅(qū)動(dòng)的開(kāi)發(fā)模式下，測(cè)試數(shù)據(jù)已經(jīng)準(zhǔn)備好了，那么接口邏輯就已經(jīng)確定了接口文檔是否編寫(xiě)好了，理清它們是很自然的。

-第一，主觀(guān)原因。原因是多方面的，比如趕進(jìn)度，沒(méi)有時(shí)間，不懶得寫(xiě)，甚至在開(kāi)發(fā)前沒(méi)有仔細(xì)設(shè)計(jì)，在做的時(shí)候也有變化。真的沒(méi)有好辦法。

-客觀(guān)原因：需求在變化，功能在變化，接口也在變化。所以，如果你寫(xiě)了一個(gè)文件，它的自然更新和維護(hù)？天哪？

有解決方案嗎？建議嘗試：[1]swagger接口文檔，將文檔集成到代碼中，集成維護(hù)文檔和修改代碼，在修改代碼邏輯的同時(shí)方便修改文檔描述。

2、郵遞員界面測(cè)試工具，導(dǎo)入導(dǎo)出JSON文件，高效的團(tuán)隊(duì)合作。Postman支持各種請(qǐng)求方法和配置環(huán)境變量，對(duì)返回的結(jié)果進(jìn)行測(cè)試和驗(yàn)證，支持批量自動(dòng)操作，可與自動(dòng)構(gòu)建系統(tǒng)集成。