spring mvc中配置Swagger2

一、添加swagger2依赖的pom文件

<!--swagger配置-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.5.0</version>
        </dependency>

二、创建SwaggerConfig.java的配置文件

package com.gsw.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.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * SwaggerConfig的配置文件
 */
@EnableWebMvc
@EnableSwagger2
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.gsw.controller"))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger测试文档接口")
                .description("后台文档")
                .version("V0.0.1")
                .termsOfServiceUrl("http://localhost:8080/webDemo/swagger-ui.html")
                .contact("名称") //
                .license("")
                .build();
    }
}

三、在spring的配置中添加Swagger2的配置项

   <!--swagger 配置-->
    <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
    <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>

四、在controller中添加配置

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

/**
 * 这里主要是配置@Api和每个请求方法上面的@ApiOperation
 */
@Controller(value = "bookController")
@RequestMapping("/book")
@Api(description = "书本接口描述")
public class BookController {
    
    @ApiOperation(value = "查询书本列表", httpMethod = "GET")
    @RequestMapping(value = "/hello", method = {RequestMethod.GET, RequestMethod.POST})
    public ModelAndView hello(HttpServletRequest request) {
        ModelAndView mv = new ModelAndView("hello");
       
        return mv;
    }

}

五、启动服务器，访问

http://localhost:8080/webDemo/swagger-ui.html