java - REST API命名问题请教

 不要说话-2502882353 发布于 2022-10-25 06:39

雇员类

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

api

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

  2. GET /employee/{code}

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

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

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

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

    2022-10-26 14:22 回答
  • /employee/code/{code}

    2022-10-26 14:22 回答
撰写答案
今天,你开发时遇到什么问题呢?
立即提问
热门标签
PHP1.CN | 中国最专业的PHP中文社区 | PNG素材下载 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有