本篇主要簡單說明一下基於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