spring mvc 整合swagger2

最新推荐文章于 2022-05-31 15:20:53 发布

原创最新推荐文章于 2022-05-31 15:20:53 发布 · 408 阅读

0 ·

CC 4.0 BY-SA版权

java 同时被 2 个专栏收录

40 篇文章

订阅专栏

java框架类

23 篇文章

订阅专栏

本文详细介绍了如何在SpringMVC项目中整合Swagger2，包括在pom文件中添加依赖、配置Swagger2、修改spring-mvc.xml以及处理拦截器放行等步骤，帮助开发者快速实现API文档的自动生成。

1.在pom文件中增加新的依赖

<!--swagger2 -->

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

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


<!--jackson依赖-->
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
<dependency>
   <groupId>com.fasterxml.jackson.core</groupId>
   <artifactId>jackson-core</artifactId>
   <version>2.6.7</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations -->
<dependency>
   <groupId>com.fasterxml.jackson.core</groupId>
   <artifactId>jackson-annotations</artifactId>
   <version>2.6.7</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
   <groupId>com.fasterxml.jackson.core</groupId>
   <artifactId>jackson-databind</artifactId>
   <version>2.6.7</version>
</dependency>

<!--swagger2 -->

2.增加swagger2的配置类

package com.sunyainfo.csos.web.common.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
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;


@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.sunyainfo.csos.web")).paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("SpringMVC中使用Swagger2整合").termsOfServiceUrl("https://git.oschina.net/suntea")
                .contact(new Contact("hello", "http://www.cnblogs.com/hjava/", "elvishehai521@163.com")).version("1.0.0").build();
    }
}

3.修改spring-mvc.xml

<!-- swagger2 配置 -->
<!-- 默认的注解映射的支持 ,它会自动注册DefaultAnnotationHandlerMapping 与AnnotationMethodHandlerAdapter -->
//<mvc:annotation-driven />
<!-- 开启自动扫描  扫描controller-->
<context:component-scan base-package="com.sunyainfo.csos.web.common.swagger"></context:component-scan>
//<bean
      class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" />
<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" />
<mvc:resources mapping="/webjars/**"
            location="classpath:/META-INF/resources/webjars/" />
斜杠注释的配置会使返回值变为xml形式的

4.如果有加拦截器，需要对swagger的路径放过

包含v2/api-docs包含swagger的路径需要放过