java - REST URI 设计 : Optional and multivalue information passing

Question

我有一个搜索小部件，人们可以通过邮政编码搜索汽车经销商。还有一些可选的复选框可以优化该小部件中的搜索。

这是通过邮政编码搜索经销商的 URI。

http://localhost:8080/dealer/zip/10080

如果用户选择复选框，则 URI 将为

http://localhost:8080/dealer/zip/10080servicetype=type1&servicetype=type2&servicetype=type3

我正在使用jersey 。这是java代码。

@Path("/dealer")
@Produces(MediaType.APPLICATION_JSON)
public class DealerLocatorRS {
    private DealerService dealerService=new DealerService();

    @GET
    @Path("/zip/{zip}")
    public List<Dealer> getByZip(@PathParam("zip") String zip, 
        @QueryParam("servicetype") List<String> servicetype){
    .. . ..
    }

这是传递可选值和多个值以及 .有人可以帮助我应用最佳实践吗？

Answer 1

我不确定是否会将特定邮政编码的经销商搜索映射到资源；感觉不太对劲。相反，我有一个列出所有经销商的资源，其中各个经销商是该资源的子资源。如果可以返回受属性(例如，邮政编码)限制的子资源列表的子集，那么这将是实现搜索的好方法，否则我将有一个单独的搜索处理程序来返回链接列表匹配经销商资源。

@Path("/dealer")
public class Dealers {
    @GET
    public List<Dealer> getAll() { ... }
    @GET
    @Path("search/byZip")
    public List<URI> getByZip(@QueryParam("zip") String zip, ...) { ... }
    @Path("{dealerId:[^/]+}")
    public Dealer getDealer(@PathParam("dealerId") String id) { ... }
}