RESTful風格API介面及狀態碼

2022-08-21 07:06:06 字數 1646 閱讀 7360

1.1 什麼是restful

1.web開發本質

2.restful api設計規範

# 1)子網域名稱方式 

#盡量將api部署在專用網域名稱(會存在跨 域問題)

# 2)url方式

/api/ # api很簡單

url 如:/v1/ 

請求頭跨域時,引發傳送多次請求

/v1/zoos 

/v1/animals

/v1/employees

get(查詢資料) # 從伺服器取出資源(一項或多項) 

post(建立資料) # 在伺服器新建乙個資源

put(修改資料) # 在伺服器更新資源(客戶端提供改變後的完整資源)

patch(修改屬性) # 在伺服器更新資源(客戶端提供改變的屬性)

delete(刪除資料) # 從伺服器刪除資源

/v1/zoos?limit=10:指定返回記錄的數量 

/v1/zoos?offset=10:指定返回記錄的開始位置

/v1/zoos?page=2&per_page=100:指定第幾頁,以及每頁的記錄數

/v1/zoos?sortby=name&order=asc:指定返回結果按照哪個屬性排序, 以及排序順序

/v1/zoos?animal_type_id=1:指定篩選條件

'''1. 2xx請求成功''' 

# 200 請求成功,一般用於get與post請求

# 201 created - [post/put/patch]:使用者新建或修改資料成功。

# 202 accepted - [*]:表示乙個請求已經進入後台排隊(非同步任務)

# 204 no content - [delete]:使用者刪除資料成功。

'''2. 3xx重定向''' #

301 no content - 永久重定向

# 302 no content - 臨時重定向

'''3. 4xx客戶端錯誤'''

# 400 invalid request - [post/put/patch]:使用者發出的請求有錯誤。

# 401 unauthorized - [*]:表示使用者沒有許可權(令牌、使用者名稱、密碼錯誤)。

# 403 forbidden - [*] 表示使用者得到授權(與401錯誤相對),但是訪問是被禁止的。

# 404 not found - [*]:使用者發出的請求針對的是不存在的記錄。

# 406 not acceptable - [get]:使用者請求的格式不可得(比如使用者請求json格式,但是只有xml格 式)。

# 410 gone -[get]:使用者請求的資源被永久刪除,且不會再得到的。

# 422 unprocesable entity - [post/put/patch] 當建立乙個物件時,發生乙個驗證錯誤。

'''4. 5xx服務端錯誤'''

# 500 internal server error - [*]:伺服器內部錯誤,無法完成請求

# 501 not implemented 伺服器不支援請求的功能,無法完成請求

什麼RESTful風格API

一 url 設計 1.1 動詞 賓語 restful 的核心思想就是,客戶端發出的資料操作指令都是 動詞 賓語 的結構。比如,get articles這個命令,get是動詞,articles是賓語。動詞通常就是五種 http 方法,對應 crud 操作。get 讀取 read post 新建 cre...

restful風格API簡述

3 springboot簡述 rest是representational state transfer的縮寫 維基百科上的表達是可重新表達的狀態 rest是設計風格不是標準,按照這個風格設計出的api就叫restful api 1 資源 資源這個詞在rest中是被省略的主語資源本身是乙個具體的資訊,...

介面測試 RESTful風格介面

restful架構是一種介面設計架構風格,而不是標準,只是提供了一組設計原則。http 為我們http協議的訪問頭標準 埠號 為我們伺服器內專案訪問的指定編號 專案名稱 版本 可選 3.3 http請求方法 3.4 響應狀態 客戶端請求服務求後,伺服器響應給客戶端的狀態碼。3.5 狀態碼集合彙總 序...