Java Swagger 的相关知识讲解（swagger生成java代码）
ztj100 2025-05-08 08:09 19 浏览 0 评论
一、Swagger的作用和概念
官方地址：https://swagger.io/
Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务以及 集成Swagger自动生成API文档。
Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。
1、Swagger 的优势
- 支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
- 提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。
2、SwaggerUI 特点
- 无依赖 UI可以在任何开发环境中使用，无论是本地还是在Web端中。
- 人性化允许最终开发人员轻松地进行交互，并尝试API公开的每个操作，以方便使用。
- 易于浏览归类整齐的文档可快速查找并使用资源和端点。
- 所有浏览器支持 Swagger UI 在所有主要浏览器中均可使用，以适应各种可能的情况。
- 完全可定制 通过完整的源代码访问方式以所需方式设置和调整Swagger UI。
- 完整的OAS支持 可视化Swagger 2.0或OAS 3.0中定义的API
前后端分离：
现主流前后端开发：Vue + SpringBoot
后端时代：前端只用管理静态页面; html==》后端。模版引擎 JSP=>后端是主力
前后端分离时代：
- 后端：后端控制层、服务层、数据访问层 【后端团队】
- 前端：前端控制层、视图层 【前端团队】
- 伪造后端数据，json。在后端开发前数据以及存在，不需要后端，前端工程师依旧能将项目跑起来。
- 前后端如何交互？==>API
- 前后端相对独立，松耦合；
- 前后端甚至可以部署在不同的服务器上。
产生一个问题
前后端集成联调，前端人员和后端人员无法做到 “及时协商，尽早解决”，最终导致问题集中爆发；
SpringBoot中集成Swagger
解决方案：
首先指定scheme，实时更新最新的API，降低集成的风险。
早些年，制定Word计划文档
前后端分离：
- 前端测试后端接口使用：Postman工具。
- 后端提供接口：需要实时更新最新改动和消息。
这时Swagger很好的解决了这个问题
- 号称世界上最流行的API框架。
- Restful API文档在线自动生成工具 ，API文档与API定义同步更新
- 直接运行，可以在线测试API接口。
- 支持多种语言 如：Java 、Php等高级语言
相关推荐
- 30天学会Python编程:16. Python常用标准库使用教程
-
16.1collections模块16.1.1高级数据结构16.1.2示例...
- 强烈推荐!Python 这个宝藏库 re 正则匹配
-
Python的re模块（RegularExpression正则表达式）提供各种正则表达式的匹配操作。...
- Python爬虫中正则表达式的用法，只讲如何应用，不讲原理
-
Python爬虫：正则的用法(非原理)。大家好，这节课给大家讲正则的实际用法，不讲原理，通俗易懂的讲如何用正则抓取内容。·导入re库，这里是需要从html这段字符串中提取出中间的那几个文字。实例一个对...
- Python数据分析实战-正则提取文本的URL网址和邮箱(源码和效果)
-
实现功能：Python数据分析实战-利用正则表达式提取文本中的URL网址和邮箱...
- python爬虫教程之爬取当当网 Top 500 本五星好评书籍
-
我们使用requests和re来写一个爬虫作为一个爱看书的你（说的跟真的似的）怎么能发现好书呢？所以我们爬取当当网的前500本好五星评书籍怎么样？ok接下来就是学习python的正确姿...
- 深入理解re模块:Python中的正则表达式神器解析
-
在Python中，"re"是一个强大的模块，用于处理正则表达式（regularexpressions）。正则表达式是一种强大的文本模式匹配工具，用于在字符串中查找、替换或提取特定模式...
- 如何使用正则表达式和 Python 匹配不以模式开头的字符串
-
需要在Python中使用正则表达式来匹配不以给定模式开头的字符串吗？如果是这样，你可以使用下面的语法来查找所有的字符串，除了那些不以https开始的字符串。r"^(?!https).*&...
- 先Mark后用!8分钟读懂 Python 性能优化
-
从本文总结了Python开发时，遇到的性能优化问题的定位和解决。概述：性能优化的原则——优化需要优化的部分。性能优化的一般步骤：首先，让你的程序跑起来结果一切正常。然后，运行这个结果正常的代码，看看它...
- Python“三步”即可爬取，毋庸置疑
-
声明：本实例仅供学习，切忌遵守robots协议，请不要使用多线程等方式频繁访问网站。#第一步导入模块importreimportrequests#第二步获取你想爬取的网页地址，发送请求，获取网页内...
- 简单学Python——re库(正则表达式)2(split、findall、和sub)
-
1、split（）：分割字符串，返回列表语法：re.split（'分隔符','目标字符串'）例如：importrere.split('，','...
- Lavazza拉瓦萨再度牵手上海大师赛
-
阅读此文前，麻烦您点击一下“关注”，方便您进行讨论和分享。Lavazza拉瓦萨再度牵手上海大师赛标题:2024上海大师赛:网球与咖啡的浪漫邂逅在2024年的上海劳力士大师赛上,拉瓦萨咖啡再次成为官...
- ArkUI-X构建Android平台AAR及使用
-
本教程主要讲述如何利用ArkUI-XSDK完成AndroidAAR开发，实现基于ArkTS的声明式开发范式在android平台显示。包括：1.跨平台Library工程开发介绍...
- Deepseek写歌详细教程（怎样用deepseek写歌功能）
-
以下为结合DeepSeek及相关工具实现AI写歌的详细教程，涵盖作词、作曲、演唱全流程：一、核心流程三步法1.AI生成歌词-打开DeepSeek（网页/APP/API），使用结构化提示词生成歌词：...
- “AI说唱解说影视”走红，“零基础入行”靠谱吗?本报记者实测
-
“手里翻找冻鱼，精心的布局；老漠却不言语，脸上带笑意……”《狂飙》剧情被写成歌词，再配上“科目三”背景音乐的演唱，这段1分钟30秒的视频受到了无数网友的点赞。最近一段时间随着AI技术的发展，说唱解说影...
- AI音乐制作神器揭秘!3款工具让你秒变高手
-
在音乐创作的领域里，每个人都有一颗想要成为大师的心。但是面对复杂的乐理知识和繁复的制作过程，许多人的热情被一点点消磨。...
欢迎 你 发表评论:
- 一周热门
- 最近发表
-
- 30天学会Python编程:16. Python常用标准库使用教程
- 强烈推荐!Python 这个宝藏库 re 正则匹配
- Python爬虫中正则表达式的用法，只讲如何应用，不讲原理
- Python数据分析实战-正则提取文本的URL网址和邮箱(源码和效果)
- python爬虫教程之爬取当当网 Top 500 本五星好评书籍
- 深入理解re模块:Python中的正则表达式神器解析
- 如何使用正则表达式和 Python 匹配不以模式开头的字符串
- 先Mark后用!8分钟读懂 Python 性能优化
- Python“三步”即可爬取，毋庸置疑
- 简单学Python——re库(正则表达式)2(split、findall、和sub)
- 标签列表
-
- idea eval reset (50)
- vue dispatch (70)
- update canceled (42)
- order by asc (53)
- spring gateway (67)
- 简单代码编程 贪吃蛇 (40)
- transforms.resize (33)
- redisson trylock (35)
- 卸载node (35)
- np.reshape (33)
- torch.arange (34)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- vue foreach (34)
- idea设置编码为utf8 (35)
- vue 数组添加元素 (34)
- std find (34)
- tablefield注解用途 (35)
- python str转json (34)
- java websocket客户端 (34)
- tensor.view (34)
- java jackson (34)
- vmware17pro最新密钥 (34)
- mysql单表最大数据量 (35)