java - 这会被认为是糟糕的 RESTFul 设计吗？

Question

我正在 Spring 中首次设计 API，我有以下用例:

1. 获取所有产品。
2. 通过 ID 获取产品。

现在，我所做的是，我为此创建了一个 API，

@Path("/products")
public interface ProductResource {

    @GET
    @ApiOperation(value = "Gets all the products by criteria")
    Response getProductsByCriteria(@Context UriInfo uriInfo);
}

我正在做的是，我在查询参数中获取 ID。如果它的值为空，我将调用(在服务层)返回所有产品的方法，否则我将根据其 id(来自查询参数)调用返回特定产品的方法。

我只是想知道，这是一个糟糕的 RESTFul 设计吗？我是否应该使用两个单独的 API 来根据 ID 获取产品和获取所有产品？

Answer 1

你绝对应该拥有

• GET/products - 返回所有产品的列表
• GET/products/:id - 返回单个产品，如果未找到产品，则返回 404

通过这种方式，它更容易阅读，并且与您在互联网上找到的其他优质 API 保持一致。