SpringMVC集成Swagger2详解

SpringMVC集成Swagger2详解

一、pom.xml引入基于ma <!-- swagger -->  
        <dependency>  
            <groupId>io.springfox</groupId>  
            <artifactId>springfox-swagger2</artifactId>  
            <version>2.4.0</version>  
        </dependency>  
        <dependency>  
            <groupId>io.springfox</groupId>  
            <artifactId>springfox-swagger-ui</artifactId>  
            <version>2.4.0</version>  
        </dependency>

二、编写SwaggerConfig配置类

package com.foriseland.fsoa.pay.swagger;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
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
@ComponentScan(basePackages = {"com.foriseland.fsoa.pay.controller"})
public class SwaggerConfig {
     @Bean
        public Docket customDocket() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())      
                    .select()
                    .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
        }
 
        private ApiInfo apiInfo() {
            Contact contact = new Contact("支付组", "", "");
            return new ApiInfoBuilder()
                    .title("支付API接口")
                    .description("支付API接口")
                    .contact(contact)
                    .version("1.1.0")
                    .build();
        }
}
三、controller层的编写例子

@RequestMapping("/web/db/testConnection")
@ApiOperation(value = "GET请求", httpMethod = "GET", notes = "get请求案例")
@ResponseBody
public ResponseBean testConnection(@ApiParam(required = true, name = "name") ConnectionBean bean) {
    ResponseBean data = new ResponseBean();
    try {

        if (databaseService.testConnection(bean)) {
            data.setCode(200);
            data.setMsg("测试连接成功过");
        } else {
            data.setCode(400);
            data.setMsg("测试连接失败");
        }

    } catch (Exception e) {
        e.printStackTrace();
        data.setCode(500);
        data.setMsg(e.getMessage());
    }
    return data;
}