restful API 架構風格理解

摘要： API 主要從3方面來定義 1、資源版本相容定義 2、資源模組定義（允許多層模組） 3、動作定義（delete/update/save 等） 例如 設計訂單 CRUD restful 風格API 第一版本： 域名是...

API 主要從3方面來定義

1、資源版本相容定義

2、資源模組定義（允許多層模組）

3、動作定義（delete/update/save 等）

例如 設計訂單 CRUD restful 風格API

第一版本：

域名是https://www.daixb.com

app 代表 提供給手機應用的介面規範

v1 代表 介面版本（升級 改 v1 ）

order 代表業務模組

query 或者delete 代表業務模組裡面的真實動作

web介面也是參考這樣設計的

總之一句話： restful API 風格就是資源模組的劃分（面向業務場景面向應用劃分），更好的維護資源和 應用升級

服務端向用戶返回結果規範：

【GET】/{version}/{resources}/{resource_id}// 返回單個資源物件

【GET】/{version}/{resources}// 返回資源物件的列表

【POST】/{version}/{resources}// 返回新生成的資源物件

【PUT】/{version}/{resources}/{resource_id}// 返回完整的資源物件

【PATCH】/{version}/{resources}/{resource_id}// 返回完整的資源物件

【DELETE】/{version}/{resources}/{resource_id}// 狀態碼 200，返回完整的資源物件。

// 狀態碼 204，返回一個空文件