RESTful设计规范(部分)

注解方面

@GetMapping:查询操作使用GetMapping
@PostMapping:保存(新增)操作使用PostMapping
@PutMapping:修改操作使用PutMapping
@PatchMapping:部分修改操作使用PatchMapping,即此操作只修改实体的一部分数据
@DeleteMapping:删除操作使用DeletMapping
and 省事情况(大部分情况)下,查询使用GetMapping,其他所有操作都是用PostMapping,不会影响程序正常使用。

URL方面

在URL方面Restful规范要求只能出现名词,而不能出现动词,但是为了前后端程序员之间关系的和谐美好,一般我们不遵守此规范。
举例,在RestFul规范下,我们要操作用户实体时,请求的路径为:
RestFul 大部分情况下
查询 Get /user/{id} /getUser?id=
增加 Post /user /saveUser
改变 Put /user/{id} /modifyUser
删除 Delete /user/{id} /deleteUser?id=
问题:我们可以发现采用Restful设计规范会让前端很难通过请求来知晓此请求是做了什么,而开发讲究见名知意,所以虽然已经出现了swagger,但是大部分人依然选择能够一眼就看懂的请求命名方式。

最后更新于2021年1月7日
此文章内容并不完整,仅简单记录
原创不易,如果该文章对你有所帮助,望左上角点击关注~如有任何技术相关问题,可通过评论联系我讨论,我会在力所能及之内进行相应回复以及开单章解决该问题.

该文章如有任何错误请在评论中指出,感激不尽,转载请附出处!
个人博客首页:https://blog.csdn.net/yjrguxing ——您的每个关注和评论都对我意义重大

猜你喜欢

转载自blog.csdn.net/yjrguxing/article/details/112377362