2015-04-03 46 views
1

資源通常具有多個get方法。通過查詢參數獲得單數或得到許多。這是如何表現在藍圖?我可以使用兩種資源做到這一點,但在我看來,這是不正確的,因爲它是同一資源。如何爲資源指定多個GET操作

與此問題相關在資源層定義uri時,如何將PUT添加到資源中。

理想情況下,這是我認爲應該寫的東西,但編輯不喜歡它。我在文檔中發現HTTP_ACTION和URI可以放在一起,但編輯器似乎希望在資源級別使用URI。

# Storefronts 

## Read [GET /v1/storefronts{?query_params...}] 

+ Parameter 
    query_params ... 

+ Request Matching Storefronts (application/json) 
+ Response 200 (application/json) 

## Read [GET /v1/storefronts/{id}] 

+ Parameter 
    + id (string) ... id for record to return 
+ Request (application/json) 
+ Response 200 (application/json) 

## UPDATE [PUT /v1/storefronts/{id}] 

+ Parameter 
    + id (string) ... id for record to update 
+ Request (application/json) 
+ Response 200 (application/json) 
+0

嘿託德。謝謝你的迴應,但我已經知道了。控制器代碼沒有被表示爲不同的對象,所以我覺得文檔不應該。認爲它是一個藍圖的短暫來臨,我猜我必須忍受它。 – Justin 2015-04-12 19:21:54

回答

1

技術上你有2個資源:一個表示與身份的單個店面(通常支持GET,PUT,DELETE,貼劑),一個表示櫥窗的集合(典型地支撐GET,POST)。這裏是你如何代表API藍圖:

# Storefront [/v1/storefronts/{id}] 

## Retreive a Single Storefront [GET] 

## Update a Storefront [PUT] 

## Delete a Storefront [DELETE] 

# Storefronts Collection [/v1/storefronts] 

## List Storefronts [GET] 

## Create a New Storefront [POST]