REST API命名问题请教

发布于 2022-09-04 18:12:09 字数 262 浏览 15 评论 0

雇员类

public User{
    int id;//key
    int code;//员工编号 唯一
    String name;
    ...
}

api

  1. GET /employee/{id} 根据ID获取人员

  2. GET /employee/{code}

如上:code也是唯一的,如果这么命名是会混淆,应该如何命名?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

月隐月明月朦胧 2022-09-11 18:12:09

/employee/code/{code}

够钟 2022-09-11 18:12:09

获取唯一用户是 /employee/{id} 通过这个URL应该获取的就是 user实体对象。
对于实体对象内部的属性:code . 不应该在暴露URL 来获取。

在设计RESTURL 时候的第一个步骤就是资源抽象,要分清楚哪些是资源是可以抽取,并设计唯一URL的。哪些是不能的

神妖 2022-09-11 18:12:09

RESTful 的资源一般使用复数,code 我觉得作为搜索的条件也是可以的: /employees/search?code=xxx,当然 code 也可以作为 employee 的一个资源来获取和更改,但是通过 code 来查找 employee,应该属于搜索功能。

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文