Spring Boot集成Swagger-UI的具体步骤是什么?
时间: 2024-10-13 12:11:14 浏览: 59
Spring Boot集成Swagger-UI主要包括以下几个步骤:
1. **添加依赖**:首先,在项目的pom.xml或build.gradle文件中添加Swagger-UI的依赖。例如对于Springfox,你可以添加以下Maven依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>最新版本号</version>
</dependency>
```
或者Gradle:
```groovy
implementation 'io.springfox:springfox-swagger-ui'
```
2. **启用Springfox**:在@Configuration类上添加`@EnableSwagger2WebMvc`注解开启Swagger功能。
```java
@SpringBootApplication
@EnableSwagger2WebMvc
public class Application {
//...
}
```
3. **配置Swagger**:在application.properties或application.yml中设置Swagger的基本信息,如标题、描述和默认API路径:
```properties
swagger.enabled=true
springfox.documentation.path=/api-docs
springfox.documentation.apiInfo.title=Your API Title
springfox.documentation.apiInfo.description=Your API Description
```
4. **扫描API接口**:使用`@RestController`、`@RequestMapping`和`@ApiOperation`等SpringFox注解来标记需要包含在文档中的Controller和API方法。
5. **整合前端展示**:为了直接访问Swagger UI,你需要配置一个端点指向Swagger资源。通常这涉及到创建一个"/v2/api-docs"的映射,供Swagger自动发现并处理。你也可以选择将其部署在一个静态目录,并配置Spring MVC的静态资源处理器去处理。
6. **启动应用**:最后,运行Spring Boot应用,通过指定的Swagger URL(如`http://localhost:8080/swagger-ui.html`)就可以查看生成的API文档了。
阅读全文