前端接口 后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?
后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?一個非常好的問題。我是一個web應(yīng)用程序架構(gòu)師,多年來一直致力于回答這個問題。歡迎跟我來了解更多。后端提供接口文檔為時已晚,這是合理和不合理的。根據(jù)具體
后端開發(fā)完接口才給出接口文檔,合理嗎?你怎么看?
一個非常好的問題。我是一個web應(yīng)用程序架構(gòu)師,多年來一直致力于回答這個問題。歡迎跟我來了解更多。
后端提供接口文檔為時已晚,這是合理和不合理的。根據(jù)具體情況,總有解決辦法。讓我談?wù)勎业挠^點。
不合理:成熟的技術(shù)團隊重視功能設(shè)計,在編寫代碼之前有完整的技術(shù)文檔和功能定義。即使在TDD測試驅(qū)動的開發(fā)模式下,測試數(shù)據(jù)已經(jīng)準備好了,那么接口邏輯就已經(jīng)確定了接口文檔是否編寫好了,理清它們是很自然的。
-第一,主觀原因。原因是多方面的,比如趕進度,沒有時間,不懶得寫,甚至在開發(fā)前沒有仔細設(shè)計,在做的時候也有變化。真的沒有好辦法。
-客觀原因:需求在變化,功能在變化,接口也在變化。所以,如果你寫了一個文件,它的自然更新和維護?天哪?
有解決方案嗎?建議嘗試:[1]swagger接口文檔,將文檔集成到代碼中,集成維護文檔和修改代碼,在修改代碼邏輯的同時方便修改文檔描述。
2、郵遞員界面測試工具,導(dǎo)入導(dǎo)出JSON文件,高效的團隊合作。Postman支持各種請求方法和配置環(huán)境變量,對返回的結(jié)果進行測試和驗證,支持批量自動操作,可與自動構(gòu)建系統(tǒng)集成。
后端接口是什么?
接口是后端處理數(shù)據(jù)的連接。前端可以通過這個接口獲取后端數(shù)據(jù),否則我們的數(shù)據(jù)是靜態(tài)的
一個是HTTP協(xié)議狀態(tài)碼,另一個是業(yè)務(wù)狀態(tài)碼,這是兩碼事。業(yè)務(wù)狀態(tài)碼可以隨意定義,但您的后端開發(fā)人員只需定義與HTTP協(xié)議相同的狀態(tài)碼值即可
外行?從理論上講,JS是一種腳本語言(JavaScript),JSON(JavaScript object notation,JS)是一種輕量級的數(shù)據(jù)交換格式,是JS的子集,沒有替代,沒有替代。PHP、Java等后端語言開發(fā)的API接口返回JSON標準格式的數(shù)據(jù),方便前端調(diào)用。前端可以使用js讀取JSON數(shù)據(jù),結(jié)果顯示在網(wǎng)站上!為什么是JSON?因為JSON是一種標準的數(shù)據(jù)交互格式。大多數(shù)語言都可以讀取JSON數(shù)據(jù)。這樣,我們就可以開發(fā)多個終端,比如流行的微信小程序、應(yīng)用程序和網(wǎng)站,來同步數(shù)據(jù)
前后端分離項目,接口返回200但是里面返回500合理嗎?
是否有可能用JS替代JSON,作為后端接口返回的數(shù)據(jù)?
作為前端開發(fā)人員,我們需要的所有數(shù)據(jù)都是通過調(diào)用后端接口返回的;如何使用我們的前端接口優(yōu)雅地編寫返回值?讓我談?wù)勎覀兊暮蠖藞F隊如何編寫返回值;
首先使用JSON數(shù)據(jù)格式,因為JSON數(shù)據(jù)格式相對簡單,易于讀寫,而且是一種跨語言的數(shù)據(jù)格式。幾乎大多數(shù)編程語言都支持這種格式,如Java、PHP、python等
我們的通用界面會返回代碼和消息,然后前端會根據(jù)代碼進行判斷;如下圖所示,這是一種創(chuàng)建用戶界面的方法
代碼返回0,表示創(chuàng)建成功;代碼返回1000011,表示用戶已經(jīng)存在,前端根據(jù)代碼判斷并提示用戶。
我們的后端就是這樣寫入返回值的,這是一個前端操作。如果您有其他更好的后端接口返回值,請在評論區(qū)留言。