Spring boot 配置 swagger

Posted 沐松

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring boot 配置 swagger相关的知识,希望对你有一定的参考价值。

1、maven配置包

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2、配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo")) //这里改成你报controller报名即可
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()
                .title("RESTful APIs")
                .description("RESTFul API 文档")
                .version("1.0")
                .build();
    }
}

3、访问地址: http://localhost:8080/swagger-ui.html

 

官方使用说明:http://springfox.github.io/springfox/docs/current/

以上是关于Spring boot 配置 swagger的主要内容,如果未能解决你的问题,请参考以下文章

Spring boot 接入swagger以及使用

Spring Boot 整合Swagger 第二部 (动态配置启动Swagger,API分组管理)

如何使用 YAML 文件在 Spring Boot 中配置 Swagger?

怎么在springboot项目中使用swagger-spring-boot-starter

Spring Boot 配置swagger2没有文档解决方案

Spring Boot 禁用 Swagger 的三种方式