swagger的简单使用
时间: 2023-11-16 13:54:51 浏览: 83
Swagger是一种API文档生成工具,可以帮助开发者快速生成API文档,并提供在线测试API的功能。使用Swagger可以方便地管理和维护API文档,提高API的可读性和可维护性。
使用Swagger的步骤如下:
1. 在项目中引入Swagger依赖,例如在Maven项目中可以添加以下依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
```
2. 创建Swagger配置类,例如:
```java
@Configuration
@EnableSwagger2
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. 在Controller类中添加Swagger注解,例如:
```java
@RestController
@RequestMapping("/api")
@Api(tags = "用户管理")
public class UserController {
@GetMapping("/users")
@ApiOperation("获取用户列表")
public List<User> getUsers() {
// ...
}
}
```
4. 启动应用程序并访问http://localhost:8080/swagger-ui.html,即可查看API文档和测试API。
相关推荐
![rar](https://img-home.csdnimg.cn/images/20210720083606.png)
![pdf](https://img-home.csdnimg.cn/images/20210720083512.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)