正确的Restful API设计指南

Question

在制作后端服务器之前，我正在设计Restful API。这项服务是小型Instagram，我想知道我的restful设计是否符合REST原则。

认证

• 创建帐户：POST /auth/user
• 删除帐户：删除 /auth/user
• 登录：发布 /auth/session
• 注销：删除 /auth/session

邮政

< li >加载摘要:获取/发布 < li >创建帖子:帖子/帖子 < li >读取post : GET /posts/:post_id < li >删除帖子:DELETE /posts/:post_id < li >阅读评论:GET/posts/:post _ id/comments < li >创建评论:POST/posts/:POST _ id/comments < li >删除评论:Delete/posts/:post _ id/comments/:comment _ id < li >创建相似内容:POST /posts/:post_id/likes < Li > Read likes:GET/posts/:post _ id/likes < li >删除like:Delete/posts/:post _ id/likes/:like _ id

跟随

• 阅读以下内容：GET /followings/：user_id
• 创建如下：POST /followings/：user_id
• 删除以下内容：删除 /followings/：user_id
• 阅读关注者：GET /followers/：user_id

活动

• 阅读活动 ： GET /活动

搜索

< li >读取search:GET/filter/:search _ term

探讨

< li >阅读explore : GET /similars

我是Restful API设计的新手，所以我想为我的设计提供建议或修改。这符合原则吗？

Answer 1

我是Restful API设计的新手，所以我想为我的设计提供建议或修改。这符合原则吗？

REST不关心资源标识符的拼写。它不在乎你如何设计你的资源。它真正关心的是超媒体和缓存，以及使用标准化的事物定义，以便我们可以使用通用组件来实现有用的工作。

GET /activities
GET /95d9f08a-fb79-4a18-a630-b2e31ad7039a

这两个URI都很好；通用组件在这两种情况下都会做正确的事情，因为机器不关心拼写(假设您使用的拼写符合RFC 3986)——标识符就是标识符，机器不会试图从中提取任何语义信息。这意味着你的服务器，根据自己的权限，可以选择你想要的任何拼写。

换句话说，我们对URI的拼写大惊小怪，就像我们对变量名称的拼写大惊小怪一样——是为了让其他人更容易理解。因此，任何内部一致的拼写约定都可以，就像任何命名变量/函数/类的一致约定都可以一样。

使用GET进行所有读操作，使用POST进行所有写操作都很好——毕竟，web取得了灾难性的成功。POST有点有趣，因为您希望确保理解缓存失效的含义。