正規的團隊合作或者是專案對接，介面文件是非常重要的，一般介面文件都是通過開發人員寫的。乙個工整的文件顯得是非重要。下面我總結下自己看到的優秀介面文件。
介面：api
目的是提**用程式與開發人員基於某軟體或硬體得以訪問一組例程的能力，而又無需訪問原始碼，或理解內部工作機制的細節。
從另乙個角度來說，api是一套協議，規定了我們與外界的溝通方式：如何傳送請求和接收響應。
我對api的理解
api就是把某些功能封裝好，方便其他人呼叫。呼叫的人只要滿足介面暴露給呼叫者的一些訪問規則就能很方便使用這些功能，並且可以不需要知道這些功能的具體實現過程。
介面分為四部分:
1、方法:新增(post) 修改(put) 刪除(delete) 獲取(get)
2、uri：以/a開頭，如果需要登入才能呼叫的介面(如新增、修改；前台的使用者個人資訊，資金資訊等)後面需要加/u，
即：/a/u；中間一般放表名或者能表達這個介面的單詞；get方法，如果是後台通過搜尋查詢列表，那麼以/search結尾，
如果是前台的查詢列表，以/list結尾。
3、請求引數和返回引數，都分為5列：字段、說明、型別、備註、是否必填
欄位是類的屬性；說明是中文釋義；型別是屬性型別，只有string、number、object、array四種型別；備註是一些解釋，或者可以寫一下例子，
比如負責json結構的情況，最好寫上例子，好讓前端能更好理解；是否必填是字段的是否必填。
4、返回引數結構有幾種情況：1、如果只返回介面呼叫成功還是失敗（如新增、刪除、修改等），則只有乙個結構體：
code和message兩個引數；2、如果要返回某些引數，則有兩個結構體：1是code/mesage/data，2是data裡寫返回的引數,data是object型別；
如word格式的介面文件
如何編寫介面文件
乙個簡單的介面文件，寫完給組長看後，發現漏洞百出。下面總結一下寫文件需要注意事項 封面最好是本公司規定的封面，有logo，內容標題，版本號，公司名稱，文件產生日期。錯誤地方在於，文件的標題要和頁首中的標題一致 形式較好些。包括，版本，修訂說明，修訂日期，修訂人，審核時間審核人。我錯誤的地方在於，中其...
如何規範編寫介面文件
編寫乙份基本的介面文件要注意以下幾點 1.一定要有版本號，因為基本上對應的介面都是剛開發或者待開發的 已經正常使用的介面也不需要你來寫文件 不可能一次提供最終版，方便後續更改，同時避免因為修改多次導致雙方使用不一樣的文件而出錯。2.要有目錄和時間 建立時間，修改時間 3.介面文件最重要的是介面的詳細...
16 如何編寫介面文件
使用者登入介面 介面位址 localhost 8000 login 請求方式 post 引數名描述 引數型別 是否必填 username 使用者名稱string 是password 密碼string 是 建立部落格介面 介面位址 localhost 8000 add article 請求方式 pos...