1、导入相关依赖
<!-- 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、配置swagger的配置文件
@Configuration //配置文件
public class SwaggerConfig {
@Bean
public Docket productApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//扫描有注解的@ApiOperation注解的
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//扫描的包 //.apis(RequestHandlerSelectors.basePackage("com.systop.demoswagger.controller"))
.paths(PathSelectors.any())
.build();
}
// 配置文档信息
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot整合Swagger") //标题
.description("Swagger文档") //描述
// 联系人信息 Contact("联系人名字", "联系人访问链接(我写的博客地址)", "联系人邮箱");
.contact(new Contact("璒璒","https://blog.youkuaiyun.com/kriswu_deng?type=blog","1486953997@qq.com"))
.version("1.0") //版本号
.build();
}
}
-
扫描接口的方式
①//扫描有注解的@ApiOperation注解的 (需要在controller层 加入@ApiOperation注解) .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
②//扫描的包
.apis(RequestHandlerSelectors.basePackage("com.systop.demoswagger.controller"))
3、启动swagger
@SpringBootApplication
@EnableSwagger2 //启动swagger
public class DemoSwaggerApplication {
public static void main(String[] args) {
SpringApplication.run(DemoSwaggerApplication.class,args);
}
}
4、测试完成
注:以上是个人见解,如有错误,欢迎各位大佬指正😀