在專案開發彙總，web專案的前後端是分離開發的。應用程式的開發，需要由前後端工程師共同定義介面，編寫介面文件，之後大家都根據這個介面文件進行開發，到專案結束前都要一直維護。
（1）專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發
（2）專案維護中或者專案人員更迭的時候，方便後期人員檢視、維護
要了解介面文件的規範，首先要了解介面。介面分為四部分：請求方法、url、請求引數、返回引數：
（1）方法：常用的方法就是下面的四種：get put post delete
（2）url：以/a開頭，如果需要登入才能呼叫的介面（如新增、修改；前台的使用者個人資訊，資金資訊等）後面需要加/u，即：/a/u；中間一般放表名或者能表達這個介面的單詞。get方法，若果是後台通過搜尋查詢列表，那麼以/search結尾，如果是前台的查詢列表，以/list結尾。uri位址裡不遜於出現大寫字母，如果是兩個單詞拼接，用/分開
（3）請求引數和返回引數：請求引數和返回引數都分為：字段、說明、型別、備註、是否必填這5列。
字段：類的屬性
說明：中文釋義
型別：屬性的型別，只有string、number、object、array四大類
備註：一些解釋語，或者寫簡單的示例
（4）返回引數，要分兩種情況討論：
只返回介面呼叫成功或者失敗：code、reason
返回引數：字段、型別
3.常見問題
乙份規範的介面文件應該包括什麼內容
除了上面提到的請求方法、url、請求引數、返回引數以外，還應該新增介面示例、介面文件版本號、版本修改內容、版本修改時間、修改人，錯誤**等。
下面是在**上找到的乙個介面文件示例
API介面文件 自動生成
rest framework可以自動幫助我們生成介面文件。介面文件以網頁的方式呈現。自動介面文件能生成的是繼承自apiview及其子類的檢視。安裝依賴包 pip install coreapisettings.py rest framework 在總路由中新增介面文件路徑 from rest fra...
小馬商城api介面文件
baseurl 首頁輪播，九宮格 url home multidata method get data list列表介面 url home data mehhod get data 引數 type表示商品分類 流行 pop new 精選 sell page為當前頁碼 詳情頁1.商品詳情資料 url ...
RESTful （俗稱 api介面文件）
api與使用者的通訊協議，總是使用https協議，確保互動資料的傳輸安全。應該盡量將api部署在專用網域名稱之下。如果確定api很簡單，不會有進一步擴充套件，可以考慮放在主網域名稱下。應該將api的版本號放入url。v 另一種做法是，將版本號放在http頭資訊中，但不如放入url方便和直觀。gith...