目录
第一步:引入依赖
第二步:yml配置文件添加一下内容
第三步:添加SwaggerConfig配置类
第四步:启动类添加注解
第五步:Controller层类添加注解
第六步:实体类添加注解
第七步:启动项目访问Swagger
我的项目使用gradle管理依赖的
第一步:引入依赖
implementation 'io.springfox:springfox-boot-starter:3.0.0'
maven引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
第二步:yml配置文件添加一下内容
spring: mvc: pathmatch: matching-strategy: ant_path_matcher
第三步:添加SwaggerConfig配置类
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class SwaggerConfig {
/**
* 配置Docket实例
* @return
*/
@Bean
public Docket getDocket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(
new ApiInfoBuilder()
.contact(new Contact("协会","https://blog.csdn.net/caijigskg?type=blog","123@qq.com"))
.title("Swagger在线文档")
.build()
)
.groupName("demo-project-123");
}
}
第四步:启动类添加注解
@EnableDiscoveryClient
第五步:Controller层类添加注解
第六步:实体类添加注解
第七步:启动项目访问Swagger
http://localhost:8080/swagger-ui/index.html