成人AV在线无码|婷婷五月激情色,|伊人加勒比二三四区|国产一区激情都市|亚洲AV无码电影|日av韩av无码|天堂在线亚洲Av|无码一区二区影院|成人无码毛片AV|超碰在线看中文字幕

接口設(shè)計(jì)文檔模板 后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?

后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?一個(gè)非常好的問題,我是工作多年的Web應(yīng)用架構(gòu)師,來回答一下這個(gè)問題。歡迎關(guān)注我,了解更多IT專業(yè)知識(shí)。后端給出接口文檔太晚,也合理也不合理,要看具體情

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

一個(gè)非常好的問題,我是工作多年的Web應(yīng)用架構(gòu)師,來回答一下這個(gè)問題。歡迎關(guān)注我,了解更多IT專業(yè)知識(shí)。


后端給出接口文檔太晚,也合理也不合理,要看具體情況,總有解決方法,我來說一下我的觀點(diǎn)。


不合理:成熟的技術(shù)團(tuán)隊(duì),重視功能設(shè)計(jì),在動(dòng)手寫代碼之前已經(jīng)有了完整的技術(shù)文檔和功能定義,甚至在TDD測(cè)試驅(qū)動(dòng)開發(fā)模式中,測(cè)試數(shù)據(jù)已經(jīng)準(zhǔn)備就緒,那么這時(shí)接口文檔不管寫沒寫,接口邏輯都是已經(jīng)確定的,整理出來是水到渠成。


合理:多存在于早期小型創(chuàng)業(yè)公司,主觀客觀原因都有。


- 先說主觀原因。趕進(jìn)度、沒時(shí)間、懶得寫,甚至開發(fā)前都沒做仔細(xì)的設(shè)計(jì),邊做邊改,這些原因普遍存在,也實(shí)在沒啥好辦法。


- 客觀原因,需求在變,功能跟著變,接口也要變,那么如果寫了文檔,理所當(dāng)然也要更新維護(hù)???我的天哪。


有解決方法嗎?建議試試:

1,Swagger接口文檔,將文檔融合到代碼中,讓維護(hù)文檔和修改代碼整合為一體,使得修改代碼邏輯的同時(shí)方便的修改文檔說明。


2,Postman接口測(cè)試工具,導(dǎo)入導(dǎo)出JSON文件,高效團(tuán)隊(duì)協(xié)作。Postman支持各種請(qǐng)求方式和配置環(huán)境變量,并對(duì)返回結(jié)果進(jìn)行測(cè)試校驗(yàn),支持批量自動(dòng)化運(yùn)行,可以和自動(dòng)構(gòu)建系統(tǒng)集成。