目錄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風格理解
rest是representational state tansfer的縮寫,可譯為 表現層狀態轉化 restful是一種軟體架構風格,而不是標準,只是提供了一組設計原則和約束條件。主要用於客戶端和服務端互動類的軟體。基於這個風格設計的軟體可以更簡潔,更有層次,更易於實現快取等機制。restful幾...
理解restful風格介面
網路應用程式,分為前端和後端兩個部分。當前的發展趨勢,就是前端裝置層出不窮 手機 平板 桌面電腦 其他專用裝置.因此,必須有一種統一的機制,方便不同的前端裝置與後端進行通訊。這導致api構架的流行,甚至出現 api first 的設計思想。restful api是目前比較成熟的一套網際網路應用程式的...
對於RestFul編碼風格的理解
resultful風格 restful風格是一種資源定位以及資源操作的風格。它既不是某種必須遵循的標準,也不是大家都不能改動的協議,而是一種編碼風格。當我們在實際的業務開放當中使用到restful風格時,會使得我們的業務進展速度很大程度度的提高。主要功能 get 用於查詢資源 post 用於建立資源...