springboot集成springdoc-openapi(模拟前端请求)

在Spring Boot中集成springdoc-openapi可以帮助你创建和维护API文档。以下是一个简单的例子,展示如何集成并模拟一个前端请求。

  1. 添加依赖到你的pom.xml



<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.10</version>
</dependency>
  1. application.propertiesapplication.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
  1. 在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);
    }
}
  1. 创建一个简单的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!";
    }
}
  1. 启动Spring Boot应用,并访问http://localhost:8080/swagger-ui.html来查看API文档和模拟前端请求。

以上代码提供了一个基本的集成示例。SpringDoc会自动生成API文档,并且Swagger UI提供了一个可视化的界面来查看和模拟API请求。

最后修改于:2024年09月04日 17:47

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日