一、什麼是介面文件？在專案開發中，web專案的前後端分離開發，APP開發，需要由前後端工程師共同定義介面，編寫介面文件，之後大家都根據這個介面文件進行開發，到專案結束前都要一直維護。
二、為什麼要寫介面文件？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裡是具體的引數。
注意：uri地址裡不允許出現大寫字母，如果是兩個單詞拼接，用/分開
示例：
請求地址：get /a/student/list
請求引數：
返回引數：
一、什麼是介面文件？在專案開發中，web專案的前後端分離開發，APP開發，需要由前後端工程師共同定義介面，編寫介面文件，之後大家都根據這個介面文件進行開發，到專案結束前都要一直維護。
二、為什麼要寫介面文件？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裡是具體的引數。
注意：uri地址裡不允許出現大寫字母，如果是兩個單詞拼接，用/分開
示例：
請求地址：get /a/student/list
請求引數：
返回引數：