新增文件:
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依赖:
<springfox.version>2.2.2</springfox.version> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>${springfox.version}</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>${springfox.version}</version> </dependency>
访问下面网址即可看到效果:
http://localhost:8080/swagger-ui.html
另外,可以通过iframe插入到自己的网页中:
<iframe src="swagger-ui.html" frameborder="0" marginheight="0" marginwidth="0" width="100%" height="900" scrolling="auto" target=‘_top‘></iframe>
时间: 2024-10-28 23:52:40