当前位置:主页 > 软件编程 > JAVA代码 >

Springboot集成swagger实现方式

时间:2022-11-30 10:58:33 | 栏目:JAVA代码 | 点击:

Swagger 提供了一个全新的维护 API 文档的方式,有4大优点:

如何实现swagger

一: pom文件加入依赖包

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

二:修改配置文件

1.application.properties 加入配置

#表示是否开启 Swagger,一般线上环境是关闭的
spring.swagger2.enabled=true

2.增加一个swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value(value = "${spring.swagger2.enabled}")
    private Boolean swaggerEnabled;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerEnabled)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swagger.boot"))//包名代表需要生成接口文档的目录包。
                .paths(PathSelectors.any())
                .build();
    }
     private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description(" Spring Boot")
                .version("1.0")
                .build();
    }
}

您可能感兴趣的文章:

相关文章