乙個簡單的介面文件，寫完給組長看後，發現漏洞百出。下面總結一下寫文件需要注意事項：
封面最好是本公司規定的封面，有logo，內容標題，版本號，公司名稱，文件產生日期。（錯誤地方在於，文件的標題要和頁首中的標題一致）
**形式較好些。包括，版本，修訂說明，修訂日期，修訂人，審核時間審核人。（我錯誤的地方在於，**中其他空白**沒有居中）
介面呼叫方式，是post方式還是get方式，介面位址，別人需要線上的哪個位址就寫哪個。（自己提前測試好線上的這個介面，是否有其他問題，千萬別犯低階的錯誤，尤其是某個字母寫錯）
一定要清晰的描述介面功能。（不要遺漏一些細節，比如介面獲取的資訊不包括哪些哪些要寫明白）
1、有乙個模板返回值，並說明每個返回引數的意義。
2、提供乙個真實的呼叫介面，真實的返回值。
為了介面安全，我們可以進行md5加密方式，或者自己公司乙個特殊的加密過程，只要雙方採用一致的加密演算法就可以呼叫介面，保證了介面呼叫的安全性。
文件大標題的字型字型大小一致，小的分標題一致，正文部分字型大小也要一致。文章整體字的類別一致，我認為微軟雅黑字型樣式給人感覺比較清晰。文件目錄，自動生成的目錄會新增些許的修飾，去掉不整齊的部分，得到乙個整齊的目錄格式。
文件在維護的時候，如有修改一定要寫上修改日期，修改人，對大的修改要有版本號變更。
我認為檢驗乙個文件寫的是否好，主要還是在內容方面，內容是否仔細沒有疏漏之處。是否發給別人使用的時候，無需溝通就能把介面調通。別人通過成功的把介面調通，這就是乙個好文件。
如何規範編寫介面文件
編寫乙份基本的介面文件要注意以下幾點 1.一定要有版本號，因為基本上對應的介面都是剛開發或者待開發的 已經正常使用的介面也不需要你來寫文件 不可能一次提供最終版，方便後續更改，同時避免因為修改多次導致雙方使用不一樣的文件而出錯。2.要有目錄和時間 建立時間，修改時間 3.介面文件最重要的是介面的詳細...
16 如何編寫介面文件
使用者登入介面 介面位址 localhost 8000 login 請求方式 post 引數名描述 引數型別 是否必填 username 使用者名稱string 是password 密碼string 是 建立部落格介面 介面位址 localhost 8000 add article 請求方式 pos...
22 如何編寫介面文件
使用者登入介面 介面位址 localhost 8000 login 請求方式 post 引數名描述 引數型別 是否必填 username 使用者名稱string 是password 密碼string 是 建立部落格介面 介面位址 localhost 8000 add article 請求方式 pos...