JavaWebAPI接⼝规范
参考资料：
⼀、Controller  对于 Post接⼝写法
旧写法：
新写法：
模型写法：
修改后swagger展⽰效果：
说明：
1、@ApiImplicitParam 中的东西显得多余
2、在RESTFUL风格中，从资源⾓度考虑的话，@PostMapping 本⾝表⽰的就是要添加⼀个资源，其后可以不添加路由
3、@RequestBody 中的 @ApiParam 显的多余
4、在BdAreaRegion模型类中加⼊@ApiModelProperty 可以让前端swagger显⽰更清晰
说明：
1、类似这种输⼊参数的空值判断可以在架构层⾯利⽤切⾯统⼀来处理或者⽤ @Valid 注解来校验
⼆： Controller 中对于 delete 接⼝写法
旧写法：
新写法：
说明：
1、删除的话⽤ @DeleteMapping 能更清晰的表⽰此操作
2、⼀般操作的话都是通过主键进⾏删除
3、在设计上应该注意此删除的话是应该从数据库中进⾏硬删除还是只是做个标记进⾏软删除
三： Controller 中对于 put 接⼝写法
影视资源站采集api接口数据
旧写法：
新写法：
说明：
1、更新单个信息最好具体明确要更新的唯⼀标识，然后加上更新后的数据
2、数据验证判断应该⽤切⾯或者是其他⽅式来做
四：Controller 中对于批量更新 put接⼝写法
旧写法：
新写法：
说明：
1、最好的话就不应该⽤Map 来进⾏⼊参传递，应该⽤类列表或数组来进⾏传递
2、对于参数⼊参应尽量表达清楚信息否则以后难以维护，特别在前后端分离的开发⽅式下
五： Controller 中 get 接⼝写法
旧⽅法：
新⽅法；
说明：
1、修改路由名：因为根据RESTFUL 风格，在路由中⼀般是不包含动词，只是包含资源，动词⼀般⽤Get/Post/Put/Delete等Http中的操作符表⽰，这也是为什么RESTFUL风格很好利⽤了HTTP协议的⼀种体现
2、⼀般Get⽅法的简单数据传递⽤参数传递或者路径传递，不⽤Body传递
旧⽅法：
说明：
1、⼀般在函数传参的过程中形参数量超过5个需要⽤类包装起来
2、如果⽤类把形参包装起来之后那@ApiImplicitParams 这些注释就可以不需要，直接在类中写
3、为了更好的区分概念和共⽤的意图，可以把分页(current/pageSize)两个字段封装成Pager类，⽤来表达分页的概念，这样其它所有的查询分页相关的函数都可以⽤Pager表达
4、⼀般简单路由中不需要带动词，除⾮是⽐较复杂的情况

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。