SpringBoot整合Swagger文档简单配置教程

tech2025-08-10  3

1.在pom文件中引入依赖

<!-- swagger 2--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-ui</artifactId> <version>2.0.1</version> </dependency> <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.0.Final</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.9</version> <scope>compile</scope> </dependency> </dependencies>

创建SwaggerConfig配置java类

import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ParameterBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.schema.ModelRef; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.service.Parameter; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.ArrayList; import java.util.List; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //自行修改为自己的包路径 .apis(RequestHandlerSelectors.basePackage("com.hxtx.spacedata")) .paths(PathSelectors.any()) .build() .globalOperationParameters(globalOperation()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("时空数据接口文档") .description("时空数据接口文档") //服务条款网 .termsOfServiceUrl("") //版本号 .version("2.0") .contact(new Contact("sbq", "", "")) .build(); } /** * 接口单独传token */ private List<Parameter> globalOperation() { //添加head参数配置start ParameterBuilder tokenPar = new ParameterBuilder(); List<Parameter> pars = new ArrayList<>(); //第一个token为传参的key,第二个token为swagger页面显示的值 tokenPar.name("x-access-token").description("token鉴权").modelRef(new ModelRef("string")).parameterType("header").required(false).build(); pars.add(tokenPar.build()); return pars; } }

此时启动项目,输入http://localhost:80/doc.html,能够看到如下页面,说明已经配置成功了:

注:端口自己定义

最新回复(0)