api - REST API 应该选择 ID 还是名称字段?

标签 api rest web

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗?更新问题,以便可以通过 editing this post 用事实和引文回答问题.

3年前关闭。




Improve this question




我正在设计一个 REST API 并试图确定哪种是返回单个资源的更正确的方式:

/resource/{id}

或者
/resource/{name}

ID 是不可变的,所以我认为通过它选择会更好,但名称看​​起来会更友好。最佳做法是什么?我在“野外”之前见过两者都使用过。

最佳答案

基本上 REST 建立在唯一 ID 之上,因此:

GET    /resources/{id}/

应该使用。但是,没有什么可以阻止您制作 name字段唯一(现在它表现为普通的旧 ID)并在此唯一 ID 之上构建 REST。

如果这不是您所需要的和 name不能唯一,那么另一种选择是通过 name 实现过滤:
GET    /resources?name=<SOME_NAME>

也应该是 resources (复数)因为它表示引擎盖下有一个集合。

关于api - REST API 应该选择 ID 还是名称字段?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/31506341/

相关文章:

java - RESTful API 客户端如何保存 oAuth token 以供将来的请求使用?

html - 使用 Blogger API 获取的帖子数量限制(错误 400)

java - 使用别名属性将 Java 对象转换为 Json 请求

javascript - setState 不会重新渲染数组内的 react 组件

javascript - png 在 Firefox/IE 中显示,但在 chrome 中不显示

api - Magento API V2 - 为 API 响应添加附加属性

java - 创建 JPEG : converting access restricted code (JPEGImageEncoder) to "safe" code

javascript - 如何获取 themoviedb api 中的所有评论?

Java - 框架到 "APIzize"任何类并使其在 TCP 上可用?

java - 在 GWT 中确认浏览器退出