二、為什麼要寫介面文件？
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裡是具體的引數。
什麼是介面文件，如何寫介面，有什麼規範？
一 什麼是介面文件？二 為什麼要寫介面文件？1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭，方便後期人員檢視 維護 三 介面規範是什麼？首先介面分為四部分 方法 uri 請求引數 返回引數 1 方法 新增 post 修改 put 刪除 delete 獲...
什麼是介面文件，如何寫介面，有什麼規範？
正規的團隊合作或者是專案對接，介面文件是非常重要的，一般介面文件都是通過開發人員寫的。乙個工整的文件顯得是非重要。專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發，專案維護中或者專案人員更迭，方便後期人員檢視 維護 首先介面分為四部分 方法 uri 請求引數 返回引數 方法 新增 post...
介面文件要如何寫
乙個簡單的介面文件，寫完給組長看後，發現漏洞百出。下面總結一下寫文件需要注意事項 封面最好是本公司規定的封面，有logo，內容標題，版本號，公司名稱，文件產生日期。錯誤地方在於，文件的標題要和頁首中的標題一致 形式較好些。包括，版本，修訂說明，修訂日期，修訂人，審核時間審核人。我錯誤的地方在於，中其...