目前普遍使用RestFul風格的定義規範，以前的開發都是Get和Post。引入RestFul後，感覺接口定義規範很多。看接口地址就知道是什麽功能了。讓我們來看看色譜柱的壹些基本規格。
API和客戶端用戶之間的通信協議總是使用HTTPS協議來確保交互數據的傳輸安全。
您應該嘗試在私有域名下部署API:
如果妳確定API很簡單，不會進壹步擴展，妳可以考慮把它放在主域名:/api下。
/v{n}
1.您應該將API的版本號放在URL中。
2.采用多版本共存、增量發布。
3、n代表版本號，分為整數型和浮點型。
整數:大型函數版本，如v1、v2和v3。...
浮點型:補充功能版本，如v1.1、v1.2、v2.1、v2.2...
4.對於壹個API或服務，在生產中最多應該保留三個最詳細的版本。
路徑也稱為“端點”，表示API的具體URL。
1.在RESTful架構中，每個URL代表壹個資源，因此URL中不能有動詞，只能有名詞。
使用的名詞通常對應於數據庫中的表名。
2.數據庫中的表通常是同類記錄的“集合”，因此API中的名詞也應該是復數。
示例:/v1/products
/v 1/用戶
/v 1/員工
獲取（選擇）:從服務器獲取資源（壹個或多個項目）。
POST（CREATE）:在服務器上創建新資源。
PUT（UPDATE）:更新服務器上的資源（客戶端提供更改後的完整資源）。
DELETE（刪除）:從服務器中刪除資源。
示例:
獲取/v1/products以獲取所有商品。
GET /v1/products/ID獲取指定商品的信息。
POST /v1/products創建新產品。
PUT /v1/products/ID更新指定商品的信息。
DELETE /v1/products/ID刪除商品。有關更合理的設計，請參見9。非RESTful API的要求。
get/v 1/products/id/purchases列出了指定商品的所有投資者。
get/v 1/products/id/purchases/id獲取指定商品的指定投資者信息。
如果記錄數量很大，服務器不可能將所有記錄返回給用戶。
API應該提供分頁參數和其他過濾參數來過濾返回的結果。
/v1/products？page = 1 & amp；PageSize=20指定哪壹頁以及每頁的記錄數。
/v1/products？sortBy = name & ampOrder=asc指定對返回結果進行排序所依據的屬性以及排序順序。
傳入參數分為四種類型:
1，cookie:壹般用於OAuth認證。
2.請求頭:通常用於OAuth認證。
3.請求正文數據:
4.地址欄參數:
1）restful地址欄參數/v1/products/ID ID為產品編號，獲取產品編號ID的信息。
參見第六章。在2）獲取模式下過濾查詢字段的信息。
回應:
-
{
狀態:200。//有關詳細信息，請參見狀態。
數據:{
代碼:1，//詳見代碼。
數據:{} ||【】，//數據
消息:“成功”，//存儲響應信息提示，並以語義中文提示顯示給客戶端用戶。
SysMessage:‘success‘//存儲響應消息提示，並將其用於調試，包括中文和英文。
...//其他參數，如記錄總數等。
},
msg:‘Success‘，//存儲響應信息提示，並以語義中文提示顯示給客戶端用戶。
SysMsg:‘success“///存儲響應消息提示，調試並使用它，中英文均可。
}
-
狀態:
200:正常400:錯誤請求500:內部服務器錯誤
401:未經授權
403:禁止
404:未找到
代碼:
1:數據采集成功|操作成功0:數據采集失敗|操作失敗。
1.在實際的業務開發過程中，可能會有各種API無法通過簡單的restful規範實現。
2.壹些API需要突破restful規範的原則。
3.特別是對於移動互聯網的api設計，需要壹些特定的API來優化數據請求的交互。
1），刪除單個|批量刪除:DELETE/v 1/產品主體參數{ ids:【】}
2）頁面級API:通過壹個接口壹次性返回當前頁面需要的所有數據。
1.前端需要哪些字段，API接口應該返回哪些字段？田地既不多也不少。
2.更新功能應盡量確保第壹次返回的原始數據參數與提交更新的數據參數壹致。
3、時間參數，盡量以壹致的字符串格式傳輸，例如:
'2019-01' | '2019/01'
'2019-01-01' | '2019/01/01'
'2019-01-01 12:12:12' | '2019/01/01 12:12:12'
1，盡量使用自動接口文檔，可以在線測試，同步更新。
2.它應該包括:接口基址、接口版本和接口模塊分類。
3.每個接口應包括:
接口地址:不包含接口基址。
請求方法:get、post、put、delete等。
請求參數:數據格式默認JSON，可選表單數據，數據類型，必選與否，中文描述。
對應參數:類型和中文描述。