写一个 java spring boot 集成swagger
时间: 2023-10-01 09:04:00 浏览: 171
很高兴回答你的问题!下面是集成Swagger的步骤:
1. 添加Swagger依赖
在pom.xml文件中添加以下依赖:
```
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
```
2. 配置Swagger
在项目的配置文件(application.yml或application.properties)中添加以下配置:
```
# Swagger配置
swagger:
# 是否启用Swagger,默认为true
enabled: true
# API文档基础路径
base-package: com.example.demo.controller
# API文档标题
title: Demo API
# API文档描述
description: Demo API接口文档
# API文档版本号
version: 1.0.0
```
3. 创建Swagger配置类
创建一个SwaggerConfig类,用于配置Swagger:
```
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Autowired
private SwaggerProperties swaggerProperties;
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(swaggerProperties.getTitle())
.description(swaggerProperties.getDescription())
.version(swaggerProperties.getVersion())
.build();
}
}
```
4. 启动项目并访问Swagger
启动项目后,在浏览器中访问以下地址即可查看Swagger文档:
```
http://localhost:8080/swagger-ui.html
```
以上就是Java Spring Boot集成Swagger的步骤,希望能对你有所帮助!
阅读全文