java web和java有什么區(qū)別 后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?
后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?一個非常好的問題。我是一個web應(yīng)用程序架構(gòu)師,多年來一直致力于回答這個問題。歡迎跟我來了解更多。后端提供接口文檔為時已晚,這是合理和不合理的。根據(jù)具體
后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?
一個非常好的問題。我是一個web應(yīng)用程序架構(gòu)師,多年來一直致力于回答這個問題。歡迎跟我來了解更多。
后端提供接口文檔為時已晚,這是合理和不合理的。根據(jù)具體情況,總有解決辦法。讓我談?wù)勎业挠^點(diǎn)。
不合理:成熟的技術(shù)團(tuán)隊(duì)重視功能設(shè)計(jì),在編寫代碼之前有完整的技術(shù)文檔和功能定義。即使在TDD測試驅(qū)動的開發(fā)模式下,測試數(shù)據(jù)已經(jīng)準(zhǔn)備好了,那么接口邏輯就已經(jīng)確定了接口文檔是否編寫好了,理清它們是很自然的。
-第一,主觀原因。原因是多方面的,比如趕進(jìn)度,沒有時間,不懶得寫,甚至在開發(fā)前沒有仔細(xì)設(shè)計(jì),在做的時候也有變化。真的沒有好辦法。
-客觀原因:需求在變化,功能在變化,接口也在變化。所以,如果你寫了一個文件,它的自然更新和維護(hù)?天哪?
有解決方案嗎?建議嘗試:[1]swagger接口文檔,將文檔集成到代碼中,集成維護(hù)文檔和修改代碼,在修改代碼邏輯的同時方便修改文檔描述。
2、郵遞員界面測試工具,導(dǎo)入導(dǎo)出JSON文件,高效的團(tuán)隊(duì)合作。Postman支持各種請求方法和配置環(huán)境變量,對返回的結(jié)果進(jìn)行測試和驗(yàn)證,支持批量自動操作,可與自動構(gòu)建系統(tǒng)集成。
怎么看待一些后端程序員不寫接口文檔,老是以很忙為借口搪塞?
不寫接口文檔,一般很忙。或者沒有時間整理文件。
對于前端和后端的對接,前端開發(fā)人員一般需要后端人員提供接口文檔,而現(xiàn)在招搖過市的文檔完全可以提供這個功能。在許多情況下,后端開發(fā)人員集成了一個swagger并自動生成相應(yīng)的文檔。
您可以給后端開發(fā)人員一定的時間來學(xué)習(xí)swagger或?qū)wagger集成到項(xiàng)目中。
Service層和Dao層真的有必要每個類都加上接口嗎?
這主要取決于您的項(xiàng)目:
例如,如果項(xiàng)目中使用hibernate,以后可能會切換到mybatis,那么Dao需要使用該接口。這不會影響上層代碼的更改。
另一個例子是,項(xiàng)目是一個單一的應(yīng)用程序。任何代碼修改都需要重新編譯整個項(xiàng)目,因此不需要接口。如果項(xiàng)目是由模塊編譯和部署的,那么可以使用接口解耦。假設(shè)修改了Dao,只需要重新編譯和部署Dao模塊,而不影響上層模塊。
此外,如果項(xiàng)目團(tuán)隊(duì)中有許多新手,簡單的代碼結(jié)構(gòu)可能更合適。復(fù)雜項(xiàng)目結(jié)構(gòu)的學(xué)習(xí)成本較高。
如果工程進(jìn)度非常緊迫,我們可以用簡單粗暴的方式用經(jīng)濟(jì)成本來說明原因。
使用接口的成本是不使用接口的成本(包括后續(xù)維護(hù)成本)。
如果項(xiàng)目變化很大,部署了模塊,項(xiàng)目不急,使用接口的成本比不使用接口的成本低,雖然早期不使用接口似乎更簡單;相反,不使用接口的成本低,而且連框架都不能用~
畢竟工具是提高效率的,那你為什么不能和自己相處呢!