restful接口規范
高級別的模式是：
http(s)://server.com/app-name/{version}/{domain}/{rest-convention}
這里，{version}代表api的版本信息。{domain}是一個你可以用來定義任何技術的區域(例如：安全-允許指定的用戶可以訪問這個區域。)或者業務上的原因。(例如：同樣的功能在同一個前綴之下。)
{rest-convention} 代表這個域(domain)下，約定的rest接口集合。
單資源( singular-resourceX )
url樣例：order/ (order即指那個單獨的資源X)
- GET – 返回一個新的order
- POST- 創建一個新的order，從post請求攜帶的內容獲取值。
單資源帶id(singular-resourceX/{id} )
URL樣例：order/1 ( order即指那個單獨的資源X )
- GET – 返回id是1的order
- DELETE – 刪除id是1的order
- PUT – 更新id是1的order，order的值從請求的內容體中獲取。
復數資源(plural-resourceX/)
URL樣例:orders/
- GET – 返回所有orders
復數資源查找(plural-resourceX/search)
URL樣例：orders/search?name=123
- GET – 返回所有滿足查詢條件的order資源。(實例查詢，無關聯) – order名字等于123的。
復數資源查找(plural-resourceX/searchByXXX)
URL樣例：orders/searchByItems?name=ipad
- GET – 將返回所有滿足自定義查詢的orders – 獲取所有與items名字是ipad相關聯的orders。
單數資源(singular-resourceX/{id}/pluralY)
URL樣例：order/1/items/ (這里order即為資源X，items是復數資源Y)
- GET – 將返回所有與order id 是1關聯的items。
singular-resourceX/{id}/singular-resourceY/
URL樣例：order/1/item/
- GET – 返回一個瞬時的新的與order id是1關聯的item實例。
- POST – 創建一個與order id 是1關聯的item實例。Item的值從post請求體中獲取。
singular-resourceX/{id}/singular-resourceY/{id}/singular-resourceZ/
URL樣例：order/1/item/2/package/
- GET – 返回一個瞬時的新的與item2和order1關聯的package實例。
- POST – 創建一個新的與item 2和order1關聯的package實例，package的值從post請求體中獲得。
本文由用戶 jopen 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！