以下是Spring Boot
集成Swagger的详细步骤与配置：
1. 在pom.xml文件中添加
Swagger依赖
```
<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配置类
创建一个
SwaggerConfig类，并使用@Enable
Swagger2
注解开启
Swagger功能。在
Swagger配置类中，可以设置
Swagger的一些基本信息，比如API文档的标题、描述、版本等。
```
@Configuration
@Enable
Swagger2
public class
SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.
SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo"))
.paths(PathSelectors.any())
.build();
}
}
```
3. 配置
Swagger UI
在application.properties文件中添加以下配置，以开启
Swagger UI：
```
#
Swagger UI
springfox.documentation.
swagger-ui.enabled=true
springfox.documentation.
swagger-ui.path=/
swagger-ui.html
```
4. 配置
Swagger注解
在Controller层的
方法上添加
Swagger注解，以便生成API文档。常用的
Swagger注解有：
- @Api：用于修饰Controller类，表示这个类是
Swagger资源；
- @ApiOperation：用于修饰Controller类中的
方法，表示一个HTTP请求的操作；
- @ApiParam：用于修饰
方法中的参数，表示对参数的描述；
- @ApiImplicitParam：用于修饰
方法中的参数，表示一个请求参数的配置信息；
- @ApiModel：用于修饰响应类，表示一个返回响应的信息，比如响应的数据模型；
- @ApiModelProperty：用于修饰响应类中的属性，表示对属性的描述。
例如：
```
@RestController
@Api(value = "用户管理",
tags = "用户管理API", description = "用户管理相关接口")
public class UserController {
@ApiOperation(value = "获取用户列表", notes = "获取所有用户信息")
@GetMapping("/users")
public List<User> getUserList() {
// ...
}
@ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户信息")
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) {
// ...
}
}
```
5. 运行程序并访问
Swagger UI
启动Spring Boot项目后，在浏览器中输入http://localhost:8080/
swagger-ui.html，即可访问
Swagger UI界面。在该界面中，可以查看API接口的详细信息、测试API接口等。
2859
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
