一個非常好的問題,我是工作多年的Web應用架構師,來回答一下這個問題。我,了解更多IT專業知識。
后端給出接口文檔太晚,也合理也不合理,要看具體情況,總有解決方法,我來說一下我的觀點。
不合理:成熟的技術團隊,重視功能設計,在動手寫代碼之前已經有了完整的技術文檔和功能定義,甚至在TDD測試驅動開發模式中,測試數據已經準備就緒,那么這時接口文檔不管寫沒寫,接口邏輯都是已經確定的,整理出來是水到渠成。
合理:多存在于早期小型創業公司,主觀客觀原因都有。
-先說主觀原因。趕進度、沒時間、懶得寫,甚至開發前都沒做仔細的設計,邊做邊改,這些原因普遍存在,也實在沒啥好辦法。
-客觀原因,需求在變,功能跟著變,接口也要變,那么如果寫了文檔,理所當然也要更新維護啊?我的天哪。
有解決方法嗎?建議試試:
1,Swagger接口文檔,將文檔融合到代碼中,讓維護文檔和修改代碼整合為一體,使得修改代碼邏輯的同時方便的修改文檔說明。
2,Postman接口測試工具,導入導出JSON文件,高效團隊協作。Postman支持各種請求方式和配置環境變量,并對返回結果進行測試校驗,支持批量自動化運行,可以和自動構建系統集成。