swagger

最新推荐文章于 2025-08-09 15:58:26 发布

原创最新推荐文章于 2025-08-09 15:58:26 发布 · 92 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

本文介绍了一个使用Springfox和Swagger实现API文档自动生成的配置类。该配置类通过Docket组件指定Swagger 2作为文档类型，并设置了API基本信息如版本和服务描述等。此外还定义了路径映射和默认包含模式。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

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

/**
* api doc -- springfox swagger configuration
*/
@Configuration
@EnableSwagger2
public class MySwaggerConfig implements EnvironmentAware {
    private final Logger log = LoggerFactory.getLogger(MySwaggerConfig.class);
    public static final String DEFAULT_INCLUDE_PATTERN = ".*";
    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)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .pathMapping("/ms/")
                .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(
                "soc",
                "socservice",
                "1.0.0",
                "/ms",
                "2008-hj@163.com",
                "",
                ""
        );
    }
}