java - REST API命名問題請教

問題描述

public User{ int id;//key int code;//員工編號 唯一 String name; ...}api

GET /employee/{id} 根據ID獲取人員

GET /employee/{code}

如上：code也是唯一的，如果這么命名是會混淆，應該如何命名？

問題解答

/employee/code/{code}

獲取唯一用戶是 /employee/{id} 通過這個URL應該獲取的就是 user實體對象。對于實體對象內部的屬性：code . 不應該在暴露URL 來獲取。

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

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