springboot 使用wagger
时间: 2023-07-21 13:03:40 浏览: 58
Spring Boot 是一个开源的 Java 框架,用于快速构建独立的、可部署的、生产级的 Spring 应用程序。Swagger 是一个用于设计、构建、文档化和使用 RESTful Web 服务的强大工具集。它可以自动生成 RESTful API 的文档,并提供一个交互式的界面,方便开发者测试 API。
要在 Spring Boot 中使用 Swagger,你可以按照以下步骤操作:
1. 在 Maven 或 Gradle 中添加 Swagger 的依赖。对于 Maven,你可以在 `pom.xml` 文件中添加以下代码:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
2. 创建一个 Swagger 配置类,用于配置 Swagger 的相关信息。你可以创建一个类,并使用 `@Configuration` 注解标记该类。
```java
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.OAS_30)
.select()
.apis(RequestHandlerSelectors.basePackage("your.package.name"))
.paths(PathSelectors.any())
.build();
}
}
```
将 `your.package.name` 替换为你的项目中包含 RESTful API 的包名。
3. 启动应用程序,并访问 `http://localhost:8080/swagger-ui/`,你将看到一个自动生成的 Swagger 文档界面。在该界面上,你可以查看和测试你的 API。
这样,你就可以在 Spring Boot 中使用 Swagger 来生成 API 文档和进行测试了。希望对你有帮助!如果有任何问题,请随时提问。
相关推荐
![zip](https://img-home.csdnimg.cn/images/20210720083736.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)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)