1

资源通常有多个 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)
4

1 回答 1

1

从技术上讲，您有 2 个资源：一个代表具有标识的单个 Storefront（通常支持 GET、PUT、DELETE、PATCH），另一个代表 Storefront 的集合（通常支持 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]
于 2015-04-07T22:14:41.597 回答