怎么看待一些后端程序員不寫接口文檔，老是以很忙為借口搪塞？不寫接口文檔，一般很忙。或者沒有時間整理文件。對于前端和后端的對接，前端開發(fā)人員一般需要后端人員提供接口文檔，而現(xiàn)在招搖過市的文檔完全可以提供

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

不寫接口文檔，一般很忙。或者沒有時間整理文件。

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

您可以給后端開發(fā)人員一定的時間來學習swagger或將swagger集成到項目中。

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

一個非常好的問題。我是一個web應用程序架構師，多年來一直致力于回答這個問題。歡迎跟我來了解更多。

后端提供接口文檔為時已晚，這是合理和不合理的。根據(jù)具體情況，總有解決辦法。讓我談談我的觀點。

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

-第一，主觀原因。原因是多方面的，比如趕進度，沒有時間，不懶得寫，甚至在開發(fā)前沒有仔細設計，在做的時候也有變化。真的沒有好辦法。

-客觀原因：需求在變化，功能在變化，接口也在變化。所以，如果你寫了一個文件，它的自然更新和維護？天哪？

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

2、郵遞員界面測試工具，導入導出JSON文件，高效的團隊合作。Postman支持各種請求方法和配置環(huán)境變量，對返回的結果進行測試和驗證，支持批量自動操作，可與自動構建系統(tǒng)集成。

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

編寫文檔，無論是接口文檔還是需求文檔。關鍵是雙方都需要能夠在第一時間理解并達成共識，這是一個好的文件。

對接口文檔有幾點建議：1。前提條件應該明確定義

前提條件包括接口環(huán)境、項目版本號等，因為許多公司同時運行多個版本。在不注意前提的情況下，很容易出現(xiàn)一些讓人歡笑的事情。測試過程中有很多問題。結果發(fā)現(xiàn)前端環(huán)境或者版本號是錯誤的，浪費了很多時間，沒有意義。

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

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

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

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