swagger+springboot的基本用法
时间: 2025-05-04 16:06:34 浏览: 26
### 集成和使用 Swagger 的基本教程
#### 准备工作
为了在 Spring Boot 项目中集成并使用 Swagger,需先确认项目的依赖管理工具(Maven 或 Gradle),以便添加必要的依赖项。
#### 添加依赖
对于 Maven 用户,在 `pom.xml` 文件内加入如下依赖:
```xml
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.14</version>
</dependency>
```
Gradle 用户则应在 `build.gradle` 文件里增加这行代码:
```groovy
implementation 'org.springdoc:springdoc-openapi-ui:1.6.14'
```
完成上述操作之后,重新构建项目以使新引入的库生效[^1]。
#### 启动应用与访问接口文档页面
当一切准备就绪后,启动 Spring Boot 应用程序。此时可通过浏览器访问两个 URL 来查看自动生成的 API 文档界面——Swagger UI 和 ReDoc 页面之一或两者皆可。通常情况下,默认路径为 `/swagger-ui/index.html` 或者 `/doc.html`[^4]。
#### 自定义配置 (可选)
如果希望对默认行为做出调整,比如更改基础包扫描位置或是启用某些特性,则可以在主类上通过注解方式实现简单定制化设置;而对于更加复杂的场景,例如安全策略设定或多模块支持等问题,则建议参照官方指南做进一步处理[^3]。
```java
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info().title("Sample Application API")
.description("This is a sample Spring Boot RESTful service using springdoc-openapi and OpenAPI 3.")
.version("v0.0.1"));
}
```
此段 Java 代码展示了怎样创建一个带有基本信息描述的对象实例,并将其注册成为 Bean 实例供框架识别使用[^5]。
阅读全文
相关推荐




















