REST API URL模式设计

Question

我目前正在开发REST API。

我正在开发一个返回与用户关联的产品的API，以及一个返回与产品相关联的产品的API。

我无法确定如何将URLpattern配置为正确。

我认为含糊不清的是，如果URL通过产品返回产品列表，则会反复列出产品。

请告诉我一个好的网址格式。

我正在考虑以下选项。

1

/domain/v1/relatedProducts/users/{userId}

/domain/v1/relatedProducts/products/{productId}

2

/domain/v1/user/{userId}/relatedProducts

/domain/v1/products/{productId}/relatedProducts

3。 请告知其他网址格式。

Answer 1

产品与用户相关，因此您应首先选择用户，然后列出所有产品。所以它应该像

/domain/v1/users/{userId}/products

请注意，我使用users而非user而products未使用relatedProducts

/domain/v1/users/{userId}/products/{productId}

另请注意，v1您可以保留或删除它，没有问题，一些主要公司使用版本部分。

您可以遵循一些最佳的网址格式实践

1. 使用名词但没有动词
2. 使用复数名词
3. 使用子资源进行关系

您可以在restapitutorial Resource Naming

找到更多有用的详细信息