首頁  >  問答  >  主體

java - REST API命名问题请教

雇员类

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

api

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

  2. GET /employee/{code}

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

怪我咯怪我咯2743 天前578

全部回覆(3)我來回復

  • 阿神

    阿神2017-04-18 10:54:41

    /employee/code/{code}

    回覆
    0
  • PHP中文网

    PHP中文网2017-04-18 10:54:41

    取得唯一使用者是 /employee/{id} 透過這個URL應該取得的就是 user實體物件。
    對於實體物件內部的屬性:code . 不應該在暴露URL 來取得。

    在設計RESTURL 時候的第一個步驟就是資源抽象,要分辨哪些是資源是可以抽取,並設計唯一URL的。哪些是不能的

    回覆
    0
  • PHP中文网

    PHP中文网2017-04-18 10:54:41

    RESTful 的資源一般使用複數,code 我覺得作為搜尋的條件也是可以的: /employees/search?code=xxx,當然code 也可以作為employee 的一個資源來獲取和更改,但是透過code 來查找employee,應該屬於搜尋功能。

    回覆
    0
  • 取消回覆