正規的團隊合作或者是專案對接，介面文件是非常重要的，一般介面文件都是通過開發人員寫的。乙個工整的文件顯得是非重要。
專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發，專案維護中或者專案人員更迭，方便後期人員檢視、維護
首先介面分為四部分：方法、uri、請求引數、返回引數
方法:新增(post) 修改(put) 刪除(delete) 獲取(get)
介面詳情
位址www.baidu.com
方式get
uri：以/a開頭，如果需要登入才能呼叫的介面(如新增、修改；前台的使用者個人資訊，資金資訊等)後面需要加/u，即：/a/u；
中間一般放表名或者能表達這個介面的單詞；get方法，如果是後台通過搜尋查詢列表，那麼以/search結尾，如果是前台的查詢列表，以/list結尾；url引數就不說了中間一般放表名或者能表達這個介面的單詞；get方法，如果是後台通過搜尋查詢列表，那麼以/search結尾，如果是前台的查詢列表，以/list結尾；url引數就不說了
請求引數和返回引數，都分為5列：字段、說明、型別、備註、是否必填
欄位是類的屬性；說明是中文釋義；型別是屬性型別，只有string、number、object、array四種型別；
備註是一些解釋，或者可以寫一下例子，比如負責json結構的情況，最好寫上例子，好讓前端能更好理解；是否必填是字段的是否必填。
返回引數結構有幾種情況：
返回介面呼叫成功還是失敗（如新增、刪除、修改等），如下圖：
返回結果
格式json
狀態碼200
success(成功)
狀態碼500
error(失敗)
狀態碼501
param error(引數錯誤)……
…如果要返回某些引數，則有兩個結構體：1是code/mesage/data，2是data裡寫返回的引數,data是object型別；
如果要返回列表，那麼有三個結構體，1是code/mesage/data,data是object，裡面放置page/size/total/totalpage/list 5個引數，其中list是arrary型別，list裡放object，object裡是具體的引數。
一、 設計原理
深入了解需求:從「客戶端-介面-資料庫」的層次上看，介面明顯扮演著承上啟下的角色，一方面要明白介面要什麼資料，另一方面要考慮如何從資料庫獲取、組織資料。所以如果不了解需求，你就無法正確抽象物件來組織資料給客戶端，也無法驗證資料庫的資料結構能否滿足需求。
了解資料庫結構:既然介面要明白如何從資料庫獲取、組織資料，就當然要了解資料庫結構啦。
了解客戶端原型:了解原型，其實更多是為了幫助你設計介面時需要提供的資料和結構。
二、設計原則
充分理由:不是隨便乙個功能就要有個介面，也不是隨便乙個需求就要加個介面。每新建乙個介面，就要有充分的理由和考慮，無意義的介面不僅增加了維護的難度，更重要是對於程式的可控性的大大降低，介面也會十分臃腫。
職責明確:乙個介面只負責乙個業務功能，比如查詢會員，但不要在查詢會員的同時還有修改許可權等類似的其他業務功能，應該分成兩個介面做。
高內聚低耦合:乙個介面要包含完整的業務功能，而不同介面之間的業務關聯要盡可能的小。
分析角度明確:設計介面分析的角度要統一明確。否則會造成介面結構的混亂。
入參格式統一:所有介面的引數格式要求及風格要統一，不要乙個介面引數是逗號分隔，另乙個就是陣列;不要乙個介面日期引數是x年x月x日風格，另乙個就是x-x-x。
狀態及訊息:提供必要的介面呼叫狀態資訊。呼叫是否成功?如果失敗，那麼失敗的原因是什麼。這些必要的資訊必須要告訴給客戶端。
控制資料量:乙個介面返回不應該包含過多的資料量，過多的資料量不僅處理複雜，對資料傳輸的壓力也非常大，會導致客戶端反應緩慢。過多的資料量很多時候都是介面劃分不明確。
什麼是介面文件，如何寫介面，有什麼規範？
一 什麼是介面文件？二 為什麼要寫介面文件？1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭，方便後期人員檢視 維護 三 介面規範是什麼？首先介面分為四部分 方法 uri 請求引數 返回引數 1 方法 新增 post 修改 put 刪除 delete 獲...
什麼是介面文件，如何寫介面，有什麼規範？
二 為什麼要寫介面文件？1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭，方便後期人員檢視 維護 三 介面規範是什麼？首先介面分為四部分 方法 uri 請求引數 返回引數 1 方法 新增 post 修改 put 刪除 delete 獲取 get 2 ur...
介面文件要如何寫
乙個簡單的介面文件，寫完給組長看後，發現漏洞百出。下面總結一下寫文件需要注意事項 封面最好是本公司規定的封面，有logo，內容標題，版本號，公司名稱，文件產生日期。錯誤地方在於，文件的標題要和頁首中的標題一致 形式較好些。包括，版本，修訂說明，修訂日期，修訂人，審核時間審核人。我錯誤的地方在於，中其...