springboot结合swagger
时间: 2023-11-08 21:06:10 浏览: 86
Spring Boot 是一个非常流行的 Java Web 开发框架,而 Swagger 是一个用于设计、构建、记录和使用 RESTful API 的工具。结合 Spring Boot 和 Swagger 可以方便地生成 API 文档并进行测试。
要在 Spring Boot 中使用 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>
```
然后,在 Spring Boot 应用程序的主类上添加 @EnableSwagger2 注解,如下所示:
```
@SpringBootApplication
@EnableSwagger2
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
```
最后,在控制器类上添加 @Api 和 @ApiOperation 注解,如下所示:
```
@RestController
@RequestMapping("/api")
@Api(value = "API", tags = "API")
public class MyController {
@GetMapping("/hello")
@ApiOperation(value = "Hello", notes = "Hello")
public String hello() {
return "Hello World!";
}
}
```
这样就可以通过访问 http://localhost:8080/swagger-ui.html 来查看生成的 API 文档了。
阅读全文