RESTful 介面規範
阿新 • • 發佈:2018-12-23
最近,我正在使用RESTfull的方式構建一個web服務。儘管現在有很多的一般的指導和提示告訴你如何定義restful介面,但是卻沒有一個明確的標準或大家都接受的schema定義去遵循。
在網上獲取了一些資訊後,我打算打破這一局面:)我打算分享一下我定義的規則和結構,並且很希望能得到一些反饋來幫助我完善這個規則,所以,不要猶豫,請毫無留情給我指出錯誤和毛病吧。</div>
高級別的模式是: http(s)://server.com/app-name/{version}/{domain}/{rest-convention}這裡,{version}代表api的版本資訊。{domain}是一個你可以用來定義任何技術的區域(例如:安全-允許指定的使用者可以訪問這個區域。)或者業務上的原因。(例如:同樣的功能在同一個字首之下。)
- GET - 返回一個新的order
- POST- 建立一個新的order,從post請求攜帶的內容獲取值。
- GET - 返回id是1的order
- DELETE - 刪除id是1的order
- PUT - 更新id是1的order,order的值從請求的內容體中獲取。
- GET - 返回所有orders
- GET - 返回所有滿足查詢條件的order資源。(例項查詢,無關聯) - order名字等於123的。
- GET - 將返回所有滿足自定義查詢的orders - 獲取所有與items名字是ipad相關聯的orders。
- GET - 將返回所有與order id 是1關聯的items。
- GET - 返回一個瞬時的新的與order id是1關聯的item例項。
- POST - 建立一個與order id 是1關聯的item例項。Item的值從post請求體中獲取。
- GET - 返回一個瞬時的新的與item2和order1關聯的package例項。
- POST - 建立一個新的與item 2和order1關聯的package例項,package的值從post請求體中獲得。
- 在使用複數資源的時候,返回的是最後一個複數資源使用的例項。
- 在使用單個資源的時候,返回的是最後一個但是資源使用的例項。
- 查詢的時候,返回的是最後一個複數實體使用的例項(們)。