示例URL: /rest/{keyword}

该URL是路径参数的示例。我们可以使用@PathParam来获取这个URL数据。

示例URL: /rest?关键词= java&limit = 10

该URL是查询参数的示例。我们可以使用@Queryparam来获取这个URL数据。

思考这个问题的基本思路是:

URI是唯一标识资源类型的特定实例的资源标识符。像生活中的其他事物一样，每个对象(某种类型的实例)都有一组属性，这些属性要么是时不变的，要么是暂时的。

在上面的例子中，一辆车是一个非常有形的物体，它具有像制造、型号和VIN这样的属性，这些属性永远不会改变，而颜色、悬挂等属性可能会随着时间的推移而改变。因此，如果我们用可能随时间变化的属性来编码URI，我们可能会得到同一个对象的多个URI:

GET /cars/honda/civic/coupe/{vin}/{color=red}

若干年后，如果这辆车的颜色变成黑色:

GET /cars/honda/civic/coupe/{vin}/{color=black}

注意，car实例本身(对象)并没有改变——只是颜色改变了。让多个URI指向同一个对象实例将迫使您创建多个URI处理程序——这不是一个有效的设计，当然也不直观。

因此，URI应该只由永远不会改变的部分组成，并且将在资源的整个生命周期中继续唯一地标识该资源。所有可能更改的内容都应该保留给查询参数，如下所示:

GET /cars/honda/civic/coupe/{vin}?color={black}

底线——多态。

细分更有层次，更“漂亮”，但可能会有限制。

例如，如果你有一个url，有三个段，每个段传递不同的参数，通过制造商，型号和颜色来搜索汽车:

www.example.com/search/honda/civic/blue

这是一个非常漂亮的url，更容易被最终用户记住，但现在你有点被这个结构困住了。假设你想让用户在搜索中搜索所有的蓝色汽车，或者所有的本田思域?查询参数可以解决这个问题，因为它给出了一个键值对。所以你可以通过:

www.example.com/search?color=blue
www.example.com/search?make=civic

现在，您可以通过键引用值——在查询代码中使用"color"或"make"。

你可以通过使用更多的段来创建一种键值结构来解决这个问题，比如:

www.example.com/search/make/honda/model/civic/color/blue

希望这有意义。

示例URL: /rest/{keyword}

该URL是路径参数的示例。我们可以使用@PathParam来获取这个URL数据。

示例URL: /rest?关键词= java&limit = 10

该URL是查询参数的示例。我们可以使用@Queryparam来获取这个URL数据。

一般来说，当资源中存在明显的“层次结构”时，我倾向于使用路径参数，例如:

/region/state/42

如果该单一资源具有状态，则可以:

/region/state/42/status

但是，如果‘region’实际上不是所公开的资源的一部分，它可能属于查询参数之一——类似于分页(如您所提到的)。

TL;DR: RESTful API设计的最佳实践是，路径参数用于标识一个或多个特定资源，而查询参数用于对这些资源进行排序/筛选。

举个例子。假设您正在为一个名为Car的实体实现RESTful API端点。你可以这样构造端点:

GET /汽车 得到/汽车/:id POST /汽车 /汽车/:id 删除/汽车/:id

这样，在指定要获取的资源时只使用路径参数，但不会以任何方式对资源进行排序/筛选。

现在假设您希望在GET请求中添加按颜色过滤汽车的功能。因为颜色不是资源(它是资源的属性)，所以可以添加一个查询参数来执行此操作。你可以像这样将查询参数添加到GET /cars请求中:

获取/汽车？颜色=蓝色

这个端点将被实现，以便只返回蓝色的汽车。

我们可以使用&符号添加更多的过滤参数:

GET /cars？color=blue&brand=ferrari

就语法而言，URL名应该全部小写。如果实体名称通常由两个英文单词组成，则应该使用连字符分隔单词，而不是驼峰大小写。

例/两个词