二、為什麼要寫介面文件?
1、專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發
2、專案維護中或者專案人員更迭,方便後期人員檢視、維護
三、介面規範是什麼?
首先介面分為四部分:方法、uri、請求引數、返回引數
1、方法:新增(post) 修改(put) 刪除(delete) 獲取(get)
2、uri:以/a開頭,如果需要登入才能呼叫的介面(如新增、修改;前台的使用者個人資訊,資金資訊等)後面需要加/u,即:/a/u;中間一般放表名或者能表達這個介面的單詞;get方法,如果是後台通過搜尋查詢列表,那麼以/search結尾,如果是前台的查詢列表,以/list結尾;url引數就不說了。
3、請求引數和返回引數,都分為5列:字段、說明、型別、備註、是否必填
欄位是類的屬性;說明是中文釋義;型別是屬性型別,只有string、number、object、array四種型別;備註是一些解釋,或者可以寫一下例子,比如負責json結構的情況,最好寫上例子,好讓前端能更好理解;是否必填是字段的是否必填。
4、返回引數結構有幾種情況:1、如果只返回介面呼叫成功還是失敗(如新增、刪除、修改等),則只有乙個結構體:code和message兩個引數;2、如果要返回某些引數,則有兩個結構體:1是code/mesage/data,2是data裡寫返回的引數,data是object型別;3、如果要返回列表,那麼有三個結構體,1是code/mesage/data,data是object,裡面放置page/size/total/totalpage/list 5個引數,其中list是arrary型別,list裡放object,object裡是具體的引數。
短路邏輯是什麼鬼?
在python語言中支援邏輯運算子,比如 假設以下變數a為 100 b為200,那麼a and b 200 a or b 100,a and b 如果a為false,則 a and b 返回false 如果x為 true 則a and b 返回 b a or b 如果 a 為 false 則 a o...
RTU FTU DTU TTU都是什麼鬼?
rtu ftu dtu ttu都是什麼鬼?rtu 英文全稱為 remote terrminal unit,中文全稱為 遠端終端單元,通常用於對現場訊號 店裡裝置的檢測和控制。ftu 英文全稱為 feeder terminal unit,中文全稱為 饋線終端單元,通常用於測量饋線的三相引數,監控,保護...
GitHub是什麼鬼哦
哇,我真的要吐槽一下github是什麼鬼啦。從開啟github 的那一刻起,我的腦海裡就充滿了兩個大字 懵逼!完全看不懂啊,全英文啊啊,連註冊都瞎整了半天啊啊啊。然後好不容易註冊完了,照著教程想要了解一下git是個什麼玩意兒,然後發現教程我也看不懂?五個教程五種方法,真叫人摸不著頭髮。所以直到最後....