用户详细信息的命名 REST API
Naming REST API of user details informations
假设您有 2 个关系 table:User 和 UserDetails。
在用户 table 中,您存储用户 ID、密码、电子邮件 ecc。
在 UserDetails table 中,您存储其他与用户相关的信息,例如用户首选项、上次登录时间、上次 IP ecc。 User和UserDetails之间存在1-1关系,它们共享相同的主键(userId)。
如何命名 REST API 以检索特定用户的 UserDetails 信息? /users/userId/userdetail 是否正确,或者您能否建议一个更好的 API 名称?
API 端点的命名方式没有正确或错误之分。最好只在您的应用程序中保持一致。由于您有两个具有相同 ID 的 table,我可能会使用端点 userdetails/{userId} 从 UserDetail table 获取信息。然后你可以有一个类似的 enpoint users/{userId} 从用户 table 获取信息。但同样,你所拥有的是完全接受table.
这里有一篇文章介绍了一些我认为有用的命名 API 端点的最佳实践:https://restfulapi.net/resource-naming/
希望对您有所帮助!
假设您有 2 个关系 table:User 和 UserDetails。 在用户 table 中,您存储用户 ID、密码、电子邮件 ecc。 在 UserDetails table 中,您存储其他与用户相关的信息,例如用户首选项、上次登录时间、上次 IP ecc。 User和UserDetails之间存在1-1关系,它们共享相同的主键(userId)。
如何命名 REST API 以检索特定用户的 UserDetails 信息? /users/userId/userdetail 是否正确,或者您能否建议一个更好的 API 名称?
API 端点的命名方式没有正确或错误之分。最好只在您的应用程序中保持一致。由于您有两个具有相同 ID 的 table,我可能会使用端点 userdetails/{userId} 从 UserDetail table 获取信息。然后你可以有一个类似的 enpoint users/{userId} 从用户 table 获取信息。但同样,你所拥有的是完全接受table.
这里有一篇文章介绍了一些我认为有用的命名 API 端点的最佳实践:https://restfulapi.net/resource-naming/
希望对您有所帮助!