springboot中 swagger 使用

最新推荐文章于 2025-07-07 18:42:17 发布

刘正全

最新推荐文章于 2025-07-07 18:42:17 发布

阅读量280

点赞数 1

CC 4.0 BY-SA版权

分类专栏： java

本文链接：https://blog.youkuaiyun.com/kspider/article/details/79301194

java 专栏收录该内容

11 篇文章

订阅专栏

本文详细介绍如何在Spring Boot项目中集成Swagger2实现RESTful API的文档自动生成及在线测试功能。通过pom.xml引入依赖并配置Swagger配置类，使得接口文档能够自动生成并展示。

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

1.pom.xml引入

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger2.version}</version>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>

</dependency>

2、swagger配置类：

package com.ht.risk.activiti.config;

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.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration extends WebMvcConfigurerAdapter implements EnvironmentAware {
private String basePackage;
private String creatName;
private String serviceName;
private RelaxedPropertyResolver propertyResolver;
private String description;

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars*")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}

@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(this.basePackage))
.paths(PathSelectors.any()).build();
}

@SuppressWarnings("deprecation")
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(this.serviceName+" Restful APIs")
.description(this.description)
.contact(this.creatName).version("1.0").build();
}

@Override
public void setEnvironment(Environment environment) {
this.propertyResolver = new RelaxedPropertyResolver(environment, null);
this.basePackage = propertyResolver.getProperty("swagger.basepackage");
this.creatName = propertyResolver.getProperty("swagger.service.developer");
this.serviceName = propertyResolver.getProperty("swagger.service.name");
this.description = propertyResolver.getProperty("swagger.service.description");
}

}

3.swagger配置文件

#swagger config
swagger.basepackage=com.ht.risk.activiti.controller
swagger.service.name=risk-activiti-service
swagger.service.description=risk-activiti-service\u540E\u7AEF\u670D\u52A1\u63A5\u53E3
swagger.service.developer=F1
spring.mvc.async.request-timeout= 10000

参考：

https://www.cnblogs.com/qiang-cnblog/p/7641367.html