編寫乙份基本的介面文件要注意以下幾點：
1.一定要有版本號，因為基本上對應的介面都是剛開發或者待開發的（已經正常使用的介面也不需要你來寫文件）不可能一次提供最終版，方便後續更改，同時避免因為修改多次導致雙方使用不一樣的文件而出錯。
2.要有目錄和時間
（建立時間，修改時間） 3.
介面文件最重要的是介面的詳細資訊，基本上滿足以下幾點就可以了：
·介面名稱
·功能說明
·提供方，呼叫方
·介面呼叫方式
·介面呼叫位址（必要時分別給出測試和生產的）
·乙個呼叫的樣例和返回的樣例
介面詳情
位址 （正式環境）
請求方式
get引數
是否必填
說明idfa
是廣告識別符號，只支援單個查詢
source
是渠道**，具體值在接入時再進行分配
返回結果
格式json
狀態碼10000
success（呼叫成功）
10001
param error(引數錯誤)
10002
query failed（查詢失敗）
10010
access prohibited(訪問拒絕)
具體返回結果舉例：
1、查詢成功}}
2、介面呼叫失敗
4.附錄
一些引數的列舉編碼表，參考資料等等。
如何編寫介面文件
乙個簡單的介面文件，寫完給組長看後，發現漏洞百出。下面總結一下寫文件需要注意事項 封面最好是本公司規定的封面，有logo，內容標題，版本號，公司名稱，文件產生日期。錯誤地方在於，文件的標題要和頁首中的標題一致 形式較好些。包括，版本，修訂說明，修訂日期，修訂人，審核時間審核人。我錯誤的地方在於，中其...
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...