Springboot整合Swagger

大家好！今天给大家分享的知识是Springboot整合Swagger

一、Swagger是什么？

Swagger是一个开源的API设计和文档工具，它可以帮助开发人员更快、更简单地设计、构建、文档化和测试RESTful API。Swagger可以自动生成交互式API文档、客户端SDK、服务器stub代码等，从而使开发人员更加容易地开发、测试和部署API 。

简单来说Swagger是一款可以根据resutful风格生成的生成的接口开发文档，并且支持做测试的一款中间软件。

二、整合步骤

1.导入依赖

首先我们要在pom.xml文件中导入swagger的相关依赖，代码如下：

    <dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger2</artifactId>
		<version>2.7.0</version>
	</dependency>

	<dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger-ui</artifactId>
		<version>2.7.0</version>
	</dependency>

2.配置类

导入完依赖我们需要写一个配置类，代码如下：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))  //添加ApiOperiation注解的被扫描
                .paths(PathSelectors.any())
                .build();

    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("swagger和springBoot整合") //title 文档标题
                .description("swagger的API文档") //description 文档内容
                .version("1.0").build();
    }
}

写完配置类我们这时候就可以使用了，在Controller层中我们加上Swagger的相关注解，代码如下：

 此处的几个注解注意区分好分别写到哪里。都写完之后我们就可以启动项目了，然后在浏览器上输入访问地址：​​​​​​http://localhost:8080/swagger-ui.html

在这里有的人可能会报404找不到页面的错，那么这里可能是被拦截掉了，我们需要再创建一个配置类来解决被拦截的问题，代码如下：

@Slf4j
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

        /* 配置Swagger */
        // 解决静态资源无法访问
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/");
        // 解决swagger无法访问
        registry.addResourceHandler("/swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

这样就解决掉了被拦截的问题。 

最终效果展示:

---

总结

以上就是我给大家分享的Springboot整合Swagger，如果对大家有用的话记得点赞收藏加关注！！！！！！谢谢观看！！！！！！！