spring boot之使用springfox swagger展示restful的api doc

为什么80%的码农都做不了架构师？>>>   

新增文件：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.bind.RelaxedPropertyResolver;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.http.ResponseEntity;
import org.springframework.util.StopWatch;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static springfox.documentation.builders.PathSelectors.regex;

/**
 * api doc -- springfox swagger configuration
 */
@Configuration
@EnableSwagger2
public class SwaggerConfiguration implements EnvironmentAware {
    private final Logger log = LoggerFactory.getLogger(SwaggerConfiguration.class);
    public static final String DEFAULT_INCLUDE_PATTERN = "/api/.*";
    private RelaxedPropertyResolver propertyResolver;

    @Override
    public void setEnvironment(Environment environment) {
        this.propertyResolver = new RelaxedPropertyResolver(environment, "swagger.");
    }

    @Bean
    public Docket swaggerSpringfoxDocket() {
        log.debug("Starting Swagger");
        StopWatch watch = new StopWatch();
        watch.start();
        Docket swaggerSpringMvcPlugin = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .genericModelSubstitutes(ResponseEntity.class)
                .select()
                .paths(regex(DEFAULT_INCLUDE_PATTERN)) // and by paths
                .build();
        watch.stop();
        log.debug("Started Swagger in {} ms", watch.getTotalTimeMillis());
        return swaggerSpringMvcPlugin;
    }

    private ApiInfo apiInfo() {
        return new ApiInfo(
                propertyResolver.getProperty("title"),
                propertyResolver.getProperty("description"),
                propertyResolver.getProperty("version"),
                propertyResolver.getProperty("termsOfServiceUrl"),
                propertyResolver.getProperty("contact"),
                propertyResolver.getProperty("license"),
                propertyResolver.getProperty("licenseUrl")
        );
    }
}

其中的DEFAULT_INCLUDE_PATTERN要适合你自己的接口格式。

用到的Maven依赖（用spring boot的spring相关的jar包，排除swagger自带的spring的jar包）：

2.2.2

        
            io.springfox
            springfox-swagger-ui
            ${springfox.version}
            
                
                    org.springframework
                    spring-beans
                
                
                    org.springframework
                    spring-context
                
                
                    org.springframework
                    spring-aop
                
                
                    org.slf4j
                    slf4j-api
                
            
        
        
            io.springfox
            springfox-swagger2
            ${springfox.version}
            
                
                    org.springframework
                    spring-beans
                
                
                    org.springframework
                    spring-context
                
                
                    org.springframework
                    spring-aop
                
                
                    org.slf4j
                    slf4j-api
                
            
        

访问下面网址即可看到效果：

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

 

另外，可以通过iframe插入到自己的网页中：

 

 

copyright = {
    "作者": "墨衣夜行", 
    "本文链接": "http://my.oschina.net/letao/blog/517852"
}

 

转载于:https://my.oschina.net/letao/blog/517852