REST API命名问题请教
雇员类
public User{
int id;//key
int code;//员工编号 唯一
String name;
...
}
api
GET /employee/{id} 根据ID获取人员
GET /employee/{code}
如上:code也是唯一的,如果这么命名是会混淆,应该如何命名?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(3)
/employee/code/{code}
获取唯一用户是 /employee/{id} 通过这个URL应该获取的就是 user实体对象。
对于实体对象内部的属性:code . 不应该在暴露URL 来获取。
在设计RESTURL 时候的第一个步骤就是资源抽象,要分清楚哪些是资源是可以抽取,并设计唯一URL的。哪些是不能的
RESTful 的资源一般使用复数,code 我觉得作为搜索的条件也是可以的: /employees/search?code=xxx,当然 code 也可以作为 employee 的一个资源来获取和更改,但是通过 code 来查找 employee,应该属于搜索功能。