我个人使用的方法是“如果对用户来说书签包含这些参数的url是有意义的，那么使用PathParam”。

For instance, if the URL for a user profile includes some profile id parameter, since this can be bookmarked by the user and/or emailed around, I would include that profile id as a path parameter. Also, another considerent to this is that the page denoted by the URL which includes the path param doesn't change -- the user will set up his/her profile, save it, and then unlikely to change that much from there on; this means webcrawlers/search engines/browsers/etc can cache this page nicely based on the path.

If a parameter passed in the URL is likely to change the page layout/content then I'd use that as a queryparam. For instance, if the profile URL supports a parameter which specifies whether to show the user email or not, I would consider that to be a query param. (I know, arguably, you could say that the &noemail=1 or whatever parameter it is can be used as a path param and generates 2 separate pages -- one with the email on it, one without it -- but logically that's not the case: it is still the same page with or without certain attributes shown.

希望这能有所帮助——我很感激这个解释可能有点模糊:)

REST本身可能不是一个标准，但是阅读一般的REST文档和博客文章应该会给你一些指导，让你更好地构造API url。大多数其他api倾向于在路径中只有资源名称和资源id。如:

/departments/{dept}/employees/{id}

一些REST api使用查询字符串进行过滤，分页和排序，但由于REST不是一个严格的标准，我建议检查一些REST api，如github和stackoverflow，看看什么可以很好地为您的用例工作。

我建议在路径中放入任何必需的参数，而任何可选参数都应该是查询字符串参数。当尝试编写匹配不同组合的URL处理程序时，在路径中放置可选参数最终会变得非常混乱。

原因其实很简单。当使用查询参数时，你可以输入字符，如“/”，你的客户端不需要对它们进行html编码。还有其他原因，但这只是一个简单的例子。至于何时使用路径变量。我想说的是，当你处理id或者路径变量是一个查询的方向时。

这就是我的工作。

如果存在基于id检索记录的场景，例如您需要获取id为15的员工的详细信息，那么您可以使用@PathParam资源。

GET /employee/{id}

如果需要获得所有员工的详细信息，但每次只需要10个，则可以使用query param

GET /employee?start=1&size=10

这表示，起始雇员id 1获得10条记录。

总之，使用@PathParam进行基于id的检索。用户@QueryParam用于过滤器，或者如果你有任何用户可以传递的固定选项列表。

在讨论QueryParam和PathParam之前。让我们首先了解URL及其组件。URL由端点+资源+ queryParam/ PathParam组成。

例如,

URL: https://app.orderservice.com/order?order=12345678

or

URL: https://app.orderservice.com/orders/12345678

在哪里

端点:https://app.orderservice.com

资源:订单

queryParam:点= 12345678

PathParam: 12345678

@QueryParam:

当需求是基于特定的条件/标准筛选请求时，使用QueryParam。标准是用?URL中资源的后面。queryParam中可以使用&符号指定多个过滤标准。

例如:

https://app.orderser.com/orders?order=12345678 &客户名=X

@PathParam:

当需要基于guid/id选择特定的顺序时，使用PathParam。PathParam是URL中资源的一部分。

例如:

https://app.orderservice.com/orders/12345678

我给一个例子来理解我们什么时候使用@Queryparam和@pathparam

例如，我正在使用一个资源是carResource类

如果你想让你的资源方法的输入是强制性的，那么使用参数类型为@pathaparam，如果你的资源方法的输入应该是可选的，那么保持参数类型为@QueryParam

@Path("/car")
class CarResource
{
    @Get
    @produces("text/plain")
    @Path("/search/{carmodel}")
    public String getCarSearch(@PathParam("carmodel")String model,@QueryParam("carcolor")String color) {
        //logic for getting cars based on carmodel and color
            -----
        return cars
    }
}

为这个资源传递请求

req uri ://address:2020/carWeb/car/search/swift?carcolor=red

如果你给出这样的要求，资源将给出基于汽车的型号和颜色

 req uri://address:2020/carWeb/car/search/swift

如果你给出这样的要求，资源方法将只显示基于快速模型的汽车

req://address:2020/carWeb/car/search?carcolor=red

如果你这样给出，我们会得到ResourceNotFound异常因为在car资源类中，我声明了carmodel为@pathPram也就是说，你必须并且应该将carmodel作为reQ uri，否则它不会将reQ传递给resource但如果你不传递颜色它也会将reQ传递给resource为什么呢因为颜色是@quetyParam，这在reQ中是可选的。