欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Spring Boot 集成 swagger2

程序员文章站 2022-07-03 08:50:42
...

1、配置pom.xml

<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>

2、 新建配置类(SwaggerConfig)

import org.springframework.beans.factory.annotation.Configurable;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configurable
@EnableSwagger2
public class SwaggerConfig {
//swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//为当前包路径
.apis(RequestHandlerSelectors.basePackage(“com.example.demo”))
.paths(PathSelectors.any())
.build();
}
//构建 api文档的详细信息函数,注意这里的注解引用的是哪个
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//页面标题
.title(“Spring Boot 测试使用 Swagger2 构建RESTful API”)
//创建人
.contact(new Contact(“SN”, “#”, “”))
//版本号
.version(“1.0”)
//描述
.description(“API 描述”)
.build();
}

}

3、第四步:配置Controller(可以不配置)

4、访问 http://localhost:8088/swagger-ui.html,可以看到如下效果

Spring Boot 集成 swagger2

问题:
Spring Boot 集成 swagger2
解决方案: 在application启动类中定义@EnableSwagger2注解
Spring Boot 集成 swagger2

相关标签: Spring Boot