編寫REST API

REST API規範
編寫REST API,實際上就是編寫處理HTTP請求的async函數,不過,REST請求和普通的HTTP請求有幾個特殊的地方:json

REST請求仍然是標準的HTTP請求,可是,除了GET請求外,POST、PUT等請求的body是JSON數據格式,請求的Content-Type爲application/json;
REST響應返回的結果是JSON數據格式,所以,響應的Content-Type也是application/json。
REST規範定義了資源的通用訪問格式,雖然它不是一個強制要求,但遵照該規範能夠讓人易於理解。api

例如,商品Product就是一種資源。獲取全部Product的URL以下:app

GET /api/products
而獲取某個指定的Product,例如,id爲123的Product,其URL以下:async

GET /api/products/123
新建一個Product使用POST請求,JSON數據包含在body中,URL以下:函數

POST /api/products
更新一個Product使用PUT請求,例如,更新id爲123的Product,其URL以下:post

PUT /api/products/123
刪除一個Product使用DELETE請求,例如,刪除id爲123的Product,其URL以下:排序

DELETE /api/products/123
資源還能夠按層次組織。例如,獲取某個Product的全部評論,使用:資源

GET /api/products/123/reviews
當咱們只須要獲取部分數據時,可經過參數限制返回的結果集,例如,返回第2頁評論,每頁10項,按時間排序:get

GET /api/products/123/reviews?page=2&size=10&sort=timeio

請求 地址 說明 get /messages 獲取全部消息 post /message 建立一個消息 put /message 修改消息內容 patch /message/text 修改消息的 text 字段 get /message/id 根據 ID 獲取消息 delete /message/id 根據 ID 刪除消息

相關文章
相關標籤/搜索