1.首先restfulf风格的api是基于资源的,url命名用来定位资源,而不是表示动作,动作通过请求方式进行表示。
2.URL中应该单复数区分,推荐的实践是永远只用复数。比如GET /api/users表示获取用户的列表,如果获取单个资源,传入ID,比如/api/users/123,表示获取单个用户的信息。
3.修改的方法可以用PUT和PATCH表示,PUT 用于更新资源的全部信息,在请求的 body 中需要传入修改后的全部资源主体,PATCH 用于局部更新,在 body 中只需要传入需要改动的资源字段。如果一个资源有很多字段,在进行局部更新时,只需要传入需要修改的字段即可,否则在用 PUT 的情况下,你不得不将整个资源模型全都发送回服务器,造成网络资源的极大浪费。
4.URI结尾不应包含(/)
5.正斜杠分隔符(/)必须用来指示层级关系
6.应使用连字符( - )来提高URI的可读性
7.不得在URI中使用下划线(_)
8.URI路径中全都使用小写字母
9.规范示例如下:
GET /api/users 获取用户的列表
GET /api/users/123 获取id为123的用户信息