2015-04-03 2 views
1

Ресурсы обычно имеют несколько методов get. Получите сингулярное значение или получите множество параметров запроса. Как это представлено в проекте? Я могу сделать это, используя два ресурса, но это, на мой взгляд, неверно, поскольку это тот же ресурс.Как вы можете указать несколько действий GET для ресурса

Связанный с этим вопросом Как добавить PUT к ресурсу, учитывая, что uri определен на уровне ресурсов.

В идеале это то, как я думаю, что все должно быть написано, но редактору это не нравится. Я нашел в документах, где 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

ответ

1

Технически у вас есть 2 ресурса: один, представляющий собой единую Storefront с единицей (как правило, поддерживает GET, PUT, DELETE, заплата) и один, представляющих коллекцию (обычно Витрины с поддержкой GET, POST). Вот как вы могли бы представить это в API Blueprint:

# 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] 

 Смежные вопросы

  • Нет связанных вопросов^_^