当前位置: 首页 > news >正文

java spring boot Swagger安装及使用

https://springdoc.org/

可能原因分析 🔍
原因 1:SpringFox 版本与 Spring Boot 版本不兼容 ❌
SpringFox 3.0.0 不完全兼容 Spring Boot 2.6+ 及更高版本,可能导致 NullPointerException。
Spring Boot 3.x 完全不支持 SpringFox,必须使用 springdoc-openapi 替代。

java spring boot Swagger 安装及使用

在前后端分离开发的过程中,前端和后端需要进行api对接进行交互,就需要一个api规范文档,方便前后端的交互,但api文档不能根据代码的变化发生实时动态的改变,这样后端修改了接口,前端不能及时获取最新的接口,导致调用出错,需要手动维护api文档,加大了开发的工作量和困难,而swagger的出现就是为了解决这一系列的问题。

Swagger是一套基于OpenAPI规范构建的开源工具,使用RestApi

代码变,文档变
跨语言,支持多种语言
Swagger-ui 呈现出来的是一份可交互式的API文档,可以直接在文档页面尝试API的调用
可以将文档规范导入相关工具(postman、soapui),这些工具将会为我们自动地创建自动化测试
RestApi格式是根据请求的方式决定本次请求的一个操作,譬如:get–>读,post–>写(增、删、改),put–>修改,delete–>删除
OpenApi与语言无关,只是一种规范,可以使用yaml和json格式进行编写,这样更利于我们和机器进行阅读

Swagger主要包含了以下三个部分:

Swagger editor:基于浏览器的编辑器,我们可以使用它编写我们OpenApi规范(yaml或者json配置)
Swagger UI:他会将我们编写的OpenApi规范呈现为交互式的API文档,后文我将使用浏览器来查看并且操作我们的RestApi
Swagger Codegen:它可以通过OpenApi规范定义的任何API生成服务器存根和客户端SDK来简化构建过程
springfox

使用swagger时如果碰见版本更新迭代时,只需要更改swagger的描述文件即可,但是在频繁的更新项目版本时很多开发人员认为即使修改描述文件(yml或json文件)也是一定的工作负担,久而久之就直接修改代码,而不去修改描述文件了,这样基于描述文件生成接口文档也失去了意义。
Marty Pitt编写了一个基于spring的组件swagger-springmvc,Spring-fox就是根据这个组件发展而来的全新项目;
Spring-fox是根据代码生成接口文档,所以正常的进行更新项目版本,修改代码即可,而不需要跟随修改描述文件(yml或json文件);
spring-fox利用自身AOP特性,把swagger集成进来,底层还是Swagger,但是使用起来却方便很多,所以在实际开发中,都是直接使用spring-fox。

相关文章:

  • 轻松搭建Linux开发环境:使用`build-essential`安装GCC编译器**
  • React Native 搭建iOS与Android开发环境
  • 【matlab】图片转视频
  • 如何理解DDD的领域和子域?
  • git回滚操作
  • 失业学习-前端工程化-webpack基础
  • 【图像处理入门】9. 基础项目实战:从去噪到图像加密
  • App Trace 快速安装解析(开发者视角)
  • 单片机 - STM32读取GPIO某一位时为什么不能直接与1判断为高电平?
  • 可展开收起的搜索项组件el-table
  • 开发工期紧急:用户体验优化5大实施策略
  • 暴雨服务器成功中标洪湖市政府框架采购项目
  • 手写一个Spring:一、IOC容器
  • 电阻、电容、电感
  • 漫画Android:从网络加载一个50MB的图片,要注意什么?
  • 探秘KingbaseES在线体验平台:技术盛宴还是虚有其表?
  • EasyExcel 4.X 读写数据
  • 『大模型笔记』第3篇:多长的 Prompt 会阻塞其他请求?优化策略解析
  • AI测试开发工程师如何用大模型调用工具:从入门到实践
  • Linux --Ext系列文件系统
  • 邮轮哪个网站是可以做特价胃肠的/网络优化报告
  • 有没有教做衣服的网站/网站推广服务报价表
  • 网站怎么优化自己免费/独立站谷歌seo
  • 找不同 网站开发/宁波网络营销推广公司
  • 网站被入侵后需做的检测 1/百度推广登录入口官网网址
  • 网站 用什么语言/360网站推广客服电话