SpringBoot3.1.2 引入Swagger
时间: 2024-10-20 20:17:31 浏览: 34
Spring Boot 3.1.2 引入 Swagger(现在更常用的是 OpenAPI)可以帮助开发者快速地创建、文档化和测试 RESTful API。以下是简要步骤:
1. 添加依赖:首先,在你的 Maven 或 Gradle 项目配置文件中添加 Swagger 的 starter 库。对于 Maven,可以在 `pom.xml` 中加入:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
@<version>3.0.0-M5</version> <!-- 使用最新稳定版本 -->
</dependency>
```
2. 配置启用:在 `application.yml` 或 `application.properties` 文件中添加 Swagger 相关的配置项,如:
```yaml
springfox.documentation.builders.ApiInfo.apiInfo(
title="Your API Name",
version="1.0.0"
)
springfox.documentation.builders.PathSelectors.any()
springfox.documentation.builders.RequestHandlerSelectors.any()
```
3. 自动扫描:为了使 Swagger 能够自动发现并生成 API 文档,你需要在配置类中添加 `@EnableSwagger2WebMvc` 注解,让 Springfox 开始工作。
4. 测试和访问:启动应用后,通常Swagger UI 将会自动部署在 `/swagger-ui.html` 端点,你可以通过浏览器访问该地址查看和测试你的 API 接口。
阅读全文