乙個簡單的介面文件，寫完給組長看後，發現漏洞百出。下面總結一下寫文件需要注意事項：
封面最好是本公司規定的封面，有logo，內容標題，版本號，公司名稱，文件產生日期。（錯誤地方在於，文件的標題要和頁首中的標題一致）
**形式較好些。包括，版本，修訂說明，修訂日期，修訂人，審核時間審核人。（我錯誤的地方在於，**中其他空白**沒有居中）
介面呼叫方式，是post方式還是get方式，介面位址，別人需要線上的哪個位址就寫哪個。（自己提前測試好線上的這個介面，是否有其他問題，千萬別犯低階的錯誤，尤其是某個字母寫錯）
一定要清晰的描述介面功能。（不要遺漏一些細節，比如介面獲取的資訊不包括哪些哪些要寫明白）
1、有乙個模板返回值，並說明每個返回引數的意義。
2、提供乙個真實的呼叫介面，真實的返回值。
為了介面安全，我們可以進行md5加密方式，或者自己公司乙個特殊的加密過程，只要雙方採用一致的加密演算法就可以呼叫介面，保證了介面呼叫的安全性。
文件大標題的字型字型大小一致，小的分標題一致，正文部分字型大小也要一致。文章整體字的類別一致，我認為微軟雅黑字型樣式給人感覺比較清晰。文件目錄，自動生成的目錄會新增些許的修飾，去掉不整齊的部分，得到乙個整齊的目錄格式。
文件在維護的時候，如有修改一定要寫上修改日期，修改人，對大的修改要有版本號變更。
我認為檢驗乙個文件寫的是否好，主要還是在內容方面，內容是否仔細沒有疏漏之處。是否發給別人使用的時候，無需溝通就能把介面調通。別人通過成功的把介面調通，這就是乙個好文件。
菜鳥歡迎您能共同討論~
什麼是介面文件，如何寫介面，有什麼規範？
一 什麼是介面文件？二 為什麼要寫介面文件？1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭，方便後期人員檢視 維護 三 介面規範是什麼？首先介面分為四部分 方法 uri 請求引數 返回引數 1 方法 新增 post 修改 put 刪除 delete 獲...
什麼是介面文件，如何寫介面，有什麼規範？
二 為什麼要寫介面文件？1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭，方便後期人員檢視 維護 三 介面規範是什麼？首先介面分為四部分 方法 uri 請求引數 返回引數 1 方法 新增 post 修改 put 刪除 delete 獲取 get 2 ur...
什麼是介面文件，如何寫介面，有什麼規範？
正規的團隊合作或者是專案對接，介面文件是非常重要的，一般介面文件都是通過開發人員寫的。乙個工整的文件顯得是非重要。專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發，專案維護中或者專案人員更迭，方便後期人員檢視 維護 首先介面分為四部分 方法 uri 請求引數 返回引數 方法 新增 post...