本篇主要简单说明一下基于Springboot+SSM+Redis+Swagger集成项目。
1.具体实现
1.1.在pom.xml整合SSM+Redis+Swagger相关依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--mybatis-plus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.0</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.10</version> </dependency> <!--模板引擎--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.12</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>jackson-dataformat-avro</artifactId> <version>2.10.0</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.6</version> </dependency> <!--guava限流--> <dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>23.0</version> </dependency> <dependency> <groupId>com.google.zxing</groupId> <artifactId>core</artifactId> <version>3.3.0</version> </dependency> <!-- Swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- 文档 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> <exclusions> <exclusion> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> </exclusion> <exclusion> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> <version>1.5.21</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.8.5</version> </dependency>
1.2.配置文件application.yaml配置
server: port: 8080 spring: main: allow-bean-definition-overriding: true thymeleaf: cache: false prefix: classpath:/templates/ mode: HTML encoding: UTF-8 jackson: date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8 locale: zh_CN # 解决json返回过程中long的精度丢失问题 generator: write-numbers-as-strings: true write-bigdecimal-as-plain: true # 配置redis redis: database: 0 password: mkxiaoer1986. host: 47.115.94.78 port: 6379 # 数据库连接配置 datasource: type: com.zaxxer.hikari.HikariDataSource driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/kuangstudy-db?serverTimezone=GMT%2b8&useUnicode=true&characterEncoding=utf-8&useSSL=false username: root password: root hikari: connection-timeout: 60000 validation-timeout: 3000 idle-timeout: 60000 login-timeout: 5 max-lifetime: 60000 maximum-pool-size: 400 minimum-idle: 100 read-only: false # mybatis-plus配置 mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl mapper-locations: classpath*:/mapper/*.xml type-aliases-package: com.kuang.entity
1.3.Swagger配置
/** * itbooking系统平台<br/> * com.itbooking.config<br/> * SweggerConfiguration.java<br/> * 创建人:mofeng <br/> * 时间：2018年9月24日-下午5:35:07 <br/> * 2018itbooking-版权所有<br/> */ package com.kuangstudy.config; import org.springframework.boot.SpringBootConfiguration; import org.springframework.context.annotation.Bean; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * @author 飞哥 * @Title: 学相伴出品 * @Description: 我们有一个学习网站：https://www.kuangstudy.com * @date 2021/5/20 13:16 */ @SpringBootConfiguration @EnableSwagger2 public class SwaggerConfiguration { /** * 在完成上述配置之后，其实就已经可以产生帮助文档了，但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生。 * 对用户体验不好，我们通常需要自己增加一些说明来丰富文档内容。如果： * 加入 * * @ApiIgnore 忽略暴露的 api * @ApiOperation(value = "查找", notes = "根据用户 ID 查找用户") * 添加说明 * <p> * <p> * 其他注解： * @Api ：用在类上，说明该类的作用 * @ApiImplicitParams ：用在方法上包含一组参数说明 * @ApiResponses ：用于表示一组响应 * 完成上述之后，启动springboot程序， * 旧访问：http://localhost:8080/swagger-ui.html * 新访问：http://localhost:8080/doc.html * @ApiOperation() 用于方法；表示一个http请求的操作 * value用于方法描述 * notes用于提示内容 * tags可以重新分组（视情况而用） * @ApiParam() 用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等） * name–参数名 * value–参数说明 * required–是否必填 * @ApiModel()用于类 ；表示对类进行说明，用于参数用实体类接收 * value–表示对象名 * description–描述 * 都可省略 * @ApiModelProperty()用于方法，字段； 表示对model属性的说明或者数据操作更改 * value–字段说明 * name–重写属性名字 * dataType–重写属性类型 * required–是否必填 * example–举例说明 * hidden–隐藏 * @ApiIgnore()用于类或者方法上，可以不被swagger显示在页面上 比较简单, 这里不做举例 * @ApiImplicitParam() 用于方法 * 表示单独的请求参数 * @ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam * name–参数ming * value–参数说明 * dataType–数据类型 * paramType–参数类型 * example–举例说明 */ @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(getApiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.kuangstudy.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo getApiInfo() { return new ApiInfoBuilder() .title("学相伴APP项目数据接口") .description("学相伴APP项目数据接口，在线体验文档") .termsOfServiceUrl("https://api.kuangstudy.com/api") .contact("徐柯，阿超，狂神") .version("1.0") .build(); } }
对应swagger新旧访问地址：
旧访问：http://localhost:8080/swagger-ui.html
新访问：http://localhost:8080/doc.html
