構造請求
更新時間 2023-05-15 16:38:56
最近更新時間: 2023-05-15 16:38:56
分享文章
1.請求的URI
例如：{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
| 參數 | 描述 | 是否必選 |
|---|---|---|
| URI-scheme | 用于傳輸請求的協議，當前所有API均采用HTTPS協議。 | 是 |
| Endpoint | 當前資源池或者通用的域名。 | 是 |
| resource-path | 資源路徑，也即API訪問路徑。從具體API的URI模塊獲取，例如“獲取用戶1信息”API的resource-path為“/users/1”。 | 是 |
| query-string | 查詢參數，是可選部分，并不是每個API都有查詢參數。查詢參數前面需要帶一個“?”，形式為“參數名=參數取值”， 例如“?userID=1”，表示查詢用戶ID為1的數據。 |
否 |
2.請求方法
| 方法 | 說明 |
|---|---|
| GET | 請求服務器返回指定資源。 |
| PUT | 請求服務器更新指定資源。 |
| POST | 請求服務器新增資源或執行特殊操作。 |
| DELETE | 請求服務器刪除指定資源，如刪除對象等。 |
| HEAD | 請求服務器資源頭部。 |
| PATCH | 請求服務器更新資源的部分內容。當資源不存在的時候，PATCH可能會去創建一個新的資源。 |
3.請求消息頭
| 名稱 | 描述 | 是否必選 | 示例 |
|---|---|---|---|
| Content-Type | 消息體的類型（格式）。推薦用戶使用默認值application/json，有其他取值時會在具體接口中專門說明。 | 是 | application/json |
| .... | .... | .... | .... |
