springboot整合swagger

it2024-04-04 62

springboot整合swagger

1.引入依赖

在springboot的pom.xml中引入swagger相关的两个案例

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency>  <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>

2.编写配置类

package com.fct.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; 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 Admin *swagger主页面的访问地址 http://localhost:8080/house/swagger-ui.html#/ */ @Configuration @EnableSwagger2 // 标记项目启用 Swagger API 接口文档 public class SwaggerConfiguration { @Bean public Docket createRestApi() { // 创建 Docket 对象 return new Docket(DocumentationType.SWAGGER_2) // 文档类型，使用 Swagger2 .apiInfo(this.apiInfo()) // 设置 API 信息 // 扫描 Controller 包路径，获得 API 接口 .select() .apis(RequestHandlerSelectors.basePackage("com.fct.controller")) .paths(PathSelectors.any()) // 构建出 Docket 对象 .build(); } /** * 创建 API 信息 */ private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("设置主题") .description("我是一段描述") .version("1.0.0") // 版本号 .build(); } }

注意:

其实配置最重要的是

.apis(RequestHandlerSelectors.basePackage(“com.fct.controller”))

记住项目中对应的controller对应的包名一定要写对

3.相关注解

参考网址:

https://blog.csdn.net/ajklaclk/article/details/80736042?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522160325149419725271728964%2522%252C%2522scm%2522%253A%252220140713.130102334…%2522%257D&request_id=160325149419725271728964&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2_alltop_click~default-3-80736042.first_rank_ecpm_v3_pc_rank_v2&utm_term=swagger%E6%B3%A8%E8%A7%A3&spm=1018.2118.3001.4187

https://blog.csdn.net/qq_34409255/article/details/88824984?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522160325149419725271728964%2522%252C%2522scm%2522%253A%252220140713.130102334…%2522%257D&request_id=160325149419725271728964&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2_allfirst_rank_v2~rank_v28-1-88824984.first_rank_ecpm_v3_pc_rank_v2&utm_term=swagger%E6%B3%A8%E8%A7%A3&spm=1018.2118.3001.4187