如何命名返回属于特定用户的订单列表的 REST API



我们有一个 REST API

/accounts/{user_id}/shop/orders

返回属于用户的所有订单。

现在我添加了按特定订单号返回订单的新 API。

/accounts/{user_id}/shop/orders/order?orders=a,b,c,d

我无法将新 API 命名为原始/accounts/{user_id}/shop/orders,因为我想将其映射到不同的控制器。

但我认为/accounts/{user_id}/shop/orders/order?orders=a,b,c,d有点奇怪,那么这种情况有什么更好的名字呢?

这是我看到的不时使用的一个建议,考虑到您必须为 2 个控制器使用不同的端点,它可以在您的情况下工作。

要返回属于用户的所有订单:

/accounts/{user_id}/shop/orders/all

/accounts/{user_id}/shop/orders/list

(我更喜欢第一个,因为第二个并不意味着列表是完整的)

要按特定订单号退回订单:

/accounts/{user_id}/shop/orders/filtered?number=a,b,c,d

通过这种方式,您可以通过/accounts/{user_id}/shop/orders路由它们,这很好,因为它们都属于那里,但仍然能够清楚地区分 2 个端点的功能。

最新更新