springboot整合openapi
时间: 2023-09-02 16:11:01 浏览: 53
Spring Boot 可以与 OpenAPI(前身为 Swagger)进行整合来构建和管理 RESTful API。下面是一些步骤来实现这个整合:
1. 导入所需的依赖:在 `pom.xml` 文件中添加以下依赖:
```xml
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.5</version>
</dependency>
```
2. 创建一个配置类:创建一个配置类来配置 OpenAPI。
```java
@Configuration
public class OpenApiConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info().title("Your API Title").version("1.0.0"));
}
}
```
在这个配置类中,你可以设置 API 的标题、版本等信息。
3. 创建 API 控制器:创建一个控制器类来定义你的 API。
```java
@RestController
public class ApiController {
@GetMapping("/hello")
public String hello() {
return "Hello, World!";
}
}
```
这里只是一个简单的示例,你可以根据你的需求添加更多的 API 方法。
4. 启动应用程序:运行你的 Spring Boot 应用程序,并访问以下 URL 来查看生成的 OpenAPI 文档:
```
http://localhost:8080/swagger-ui.html
```
你将能够在 Swagger UI 中看到你的 API 文档,并且可以通过它来测试你的 API。
这就是使用 Spring Boot 整合 OpenAPI 的基本步骤。你可以根据自己的需求来进一步配置和定制化。