springboot集成springdoc-openapi(模拟前端请求)
在Spring Boot中集成springdoc-openapi
可以帮助你创建和维护API文档。以下是一个简单的例子,展示如何集成并模拟一个前端请求。
- 添加依赖到你的
pom.xml
:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.10</version>
</dependency>
- 在
application.properties
或application.yml
中配置SpringDoc相关属性(可选):
# 配置API文档的基本路径
springdoc.api-docs.path=/api-docs
# 配置Swagger UI的基本路径
springdoc.swagger-ui.path=/swagger-ui.html
# 配置Swagger UI的标题
springdoc.swagger-ui.title=My SpringBoot App API Documentation
- 在Spring Boot应用中添加
@EnableOpenApi
注解启用SpringDoc:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import org.springdoc.core.annotations.EnableOpenApi;
@SpringBootApplication
@EnableOpenApi
public class MySpringBootApplication {
public static void main(String[] args) {
SpringApplication.run(MySpringBootApplication.class, args);
}
}
- 创建一个简单的REST控制器来模拟请求:
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
@GetMapping("/hello")
public String hello() {
return "Hello, World!";
}
}
- 启动Spring Boot应用,并访问
http://localhost:8080/swagger-ui.html
来查看API文档和模拟前端请求。
以上代码提供了一个基本的集成示例。SpringDoc会自动生成API文档,并且Swagger UI提供了一个可视化的界面来查看和模拟API请求。
评论已关闭