一个SpringBoot项目,开发业务前至少应该引入哪些配置?

前言

建立一个全新的项目,或者把旧的庞大的项目,进行拆分成多个项目。
在建立新的项目中,经常需要做一些重复的工作,比如说拷贝一下常用的工具类,通用代码等等。
所以就可以做一个基础的项目方便使用,在经历新项目的时候,直接在基础项目上进行简单配置就可以开发业务代码了。

1. 基础项目该包含哪些东西

  • Swagger在线接口文档。
  • CodeGenerator 代码生成器。
  • 统一返回。
  • 通用的分页对象。
  • 常用工具类。
  • 全局异常拦截。
  • 错误枚举。
  • 自定义异常。
  • 多环境配置文件。
  • Maven多环境配置。
  • 日志配置。
  • JenkinsFile。

2. Swagger

写接口文档通常是一件比较头疼的事情,然而swagger就用是用来帮我们解决这个问题的。可以在线生成接口文档,并且可以在页面上进行测试。
在这里插入图片描述
可以非常清楚的显示,请求数据已经响应数据。当然这一切都需要在代码中进行配置。
在这里插入图片描述
注意的点:接口文档只能在测试/开发环境开启,其他环境请关闭。

常用的Swagger注解
@Api用于Controller

@ApiOperation用于Controller内的方法。

@ApiResponses用于标识接口返回数据的类型。

@ApiModel用于标识类的名称

@ApiModelProperty用于标识属性的名称

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值