swagger2.0怎么配置
时间: 2025-03-04 08:54:55 浏览: 28
### 如何配置 Swagger 2.0 API 文档生成
为了配置 Swagger 2.0 来生成 API 文档,通常是在项目中集成特定库并按照一定结构编写注解或定义文件。对于Spring Boot应用而言,可以利用`springfox-swagger2`依赖来简化这一过程[^1]。
#### 添加 Maven 或 Gradle 依赖项
首先,在项目的构建文件里加入必要的依赖:
对于Maven用户来说,需在`pom.xml`内增加如下片段:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
而对于Gradle,则应在`build.gradle`中添加这行代码:
```groovy
implementation 'io.springfox:springfox-boot-starter:3.0.0'
```
#### 创建SwaggerConfig类
接着创建一个新的Java类命名为`SwaggerConfig.java`,用来设置Swagger的相关属性。下面给出一个简单的例子说明如何实现这一点:
```java
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
```
上述配置意味着所有的API端点都将被纳入到文档之中;当然也可以通过调整`.apis()`和`.paths()`方法中的参数来自定义哪些接口应该暴露给Swagger UI展示。
完成以上步骤之后,启动应用程序即可访问默认路径`http://localhost:<port>/swagger-ui.html`查看自动生成的API文档界面[^2]。
阅读全文
相关推荐


















