swagger2的作用（菜鸟笔记 ）

最新推荐文章于 2025-04-23 11:01:17 发布
原创 最新推荐文章于 2025-04-23 11:01:17 发布 · 922 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#swagger2

本文介绍了一种利用注释自动生成接口文档的方法，适用于前后端分离的开发模式，能够帮助开发者快速生成清晰易懂的接口文档，并提供UI进行接口测试。

写接口用的，只要用这个前后端分离，你只用写后端方法用注释显示成能让前端看得懂的页面

自动生成文档和测试接口的ui

Swagger工具的作用及使用方法
qq_45880237的博客
08-08 1777
Swagger和Postman都是常用的API开发和测试工具,Swagger使开发人员在设计和开发API时，能够更好地进行接口文档的编写、展示和管理，以及提供在线接口测试的能力
2023全网最简单但实用的SpringBoot+Vue前后端分离项目实战[青青菜鸟]-笔记+心得
qq_62649563的博客
06-05 2950
我本身基础比较薄弱，像是springBoot和Vue还没完全学会的那种，但此番为了完成课设，不得不去开始学习，但是又看不懂，于是乎找了个视频进行学习。
Swagger2的简单介绍和使用
weixin_46258873的博客
03-14 1780
1.Swagger2是什么？ Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 2.Swagger2的特点是什么？ （1） 及时性 (接口变更后，能够及时准确地通知相关前后端开发人员) （2）规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息) （3）一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧) （4）可测性 (直接在接口文档上进行测试，以方便理解业务 3、Swagger2的快速使用 （
Swagger2？有何用？
qq_40384985的博客
01-14 1361
首先给结论：swagger2 hin有用！！ 怎么个有用法？从单体应用进入到前后端分离开发模式后，我们可能经历了这么几个时代： 口头传述+钉钉（QQ\微信）私聊时代 后端在开发完获取用户列表接口后。。。 /** * 获取用户列表 * @param name 用户名，用于模糊查询，可传可不传 * @param current 第几页 * @param siz...
使用swagger2的作用
Richard_666的博客
11-25 3419
第一步：配置swagger类 package com.lpy; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.service.Contact; ...
swagger的作用
daiqinge的博客
03-08 7192
参考文章：https://blog.youkuaiyun.com/sanyaoxu_2/article/details/80555328 一. swagger简介： 在项目中，别人需要调用你的api，你可以在conference网站等地方，写文档，让别人查看。也可以有 更加 友好美观的方式，就是 maven里面配置了swagger，即下载swagger的包，在项目中进行一定的配置，别人就可以根据 相应的 ...
程序员的职业成长之路：如何从菜鸟到技术大牛的10个关键步骤
AI天才研究院
04-23 947
如何突破"重复造轮子"的低效成长状态怎样建立系统化的技术知识体系项目经验与技术深度的平衡策略从执行者到决策者的角色转型路径通过10个经过行业验证的关键步骤，提供可量化、可落地的成长指南，覆盖技术能力、工程实践、职业素养三大核心领域。建立系统化学习框架构建扎实的技术基本功在实战中打磨技术突破技术深度瓶颈掌握工程化最佳实践提升技术决策能力培养技术影响力构建个人知识管理体系制定科学的职业规划实现持续成长的底层逻辑技术栈。
《苍穹外卖Day1：大一菜鸟的代码升空纪实》
2402_88700528的博客
04-16 1527
1.注意事项 2.项目的初步了解 3.Git使用与简化 4.扩展Lombok 5.了解nginx 6.正向代理与反向代理 7.负载均衡 8.TODO工具 9.MD5加密的思考 10.Swagger,knife4j,Yapi 11.Apifox 12.Serializable接口 13.总结
【人工智能】Java接入deepseek亲测有效
JAVA领域优质创作者，基于分片网络查询方法专利发明者。
02-10 4176
* 出于与 OpenAI 兼容考虑，您也可以将 base_url 设置为 https://api.deepseek.com/v1 来使用，但注意，此处 v1 与模型版本无关。 * deepseek-chat 模型已全面升级为 DeepSeek-V3，接口不变。 通过指定 model='deepseek-chat' 即可调用 DeepSeek-V3。 * deepseek-reasoner 是 DeepSeek 最新推出的推理模型 DeepSeek-R1。通过指定 model='deepseek-reas
1.准备工作 中国专业IT社区优快云 (Chinese Software Developer Network) 创立于1999年，致力于为中国软件开发者提供知识传播、在线学习、职业发展等全生命周期服务。这里有许多IT精英分享技术、答疑解惑。不论是学习技术还是记录学习历程，优快云都是一个很好的交流平台，赶紧加入吧！ 1.1 请在优快云上注册，作业内容将以发布文章的形式提交 1.2 加入课程优快云社区 1.3 修改社区的昵称，昵称格式：学号姓名 1.4 关注老师的优快云博客： 汪璟玢老师： 优快云 1.5 学习使用Markdown文本语法撰写博客【参考附录教程1-2】 Markdown 是一种轻量级的「标记语言」，它的语法十分简单。常用的标记符号也不超过十个，这种相对于更为复杂的HTML 标记语言来说，Markdown 可谓是十分轻量的，学习成本也不需要太多。今后撰写作业文章都将用到Markdown来编写，请将优快云的默认编辑器设置为Markdown。 2.学习路线 在软件工程实践课程中，同学们可以利用个人编程作业、结对编程作业、团队项目作业，学习和熟练这项技术（因此，在挑选学习目标时，同学们需要考虑是否可以将该项技术应用到软工实践课程）；接下来，请为你的学习目标绘制你的学习路线图和思维导图🚩，要求如下： 2.1 采用专业的思维导图软件，建议可以是：MindManager、XMind、iMindMap、FreeMind、Mindomo、 MindNode……等等之一。推荐免费的Xmind。 2.2 绘制思维导图，包括但不限于以下内容：学习这门技术需要的精选的书本和网络资源、这个技术的方向和分支、入门掌握精通的学习路线图、入门掌握精通的三阶标准、 对应的岗位或应用研究方向的趋势了解和分析。 2.3 绘制路线图规划学习的时间计划，以这个学期，即6个月为周期，描述6个月内你打算学习这项技术的规划安排。 2.4 在博客中给出路线图和思维导图软件导出的图片 ⚠严禁直接COPY或抄袭现成的某个技术的路线图。路线图可以参考现有的，但必须博采众家之长，并有你自己的心血凝结其中。你绘制的路线图，从绘制到内容呈现，整体上必须是原创的。 附：之前课程中，同学们绘制的思维导图：思维导图1，完整博客1 ，思维导图2，完整博客2 ，思维导图3，完整博客3 3.往届学长学姐的建议 软件工程实践总结——It’s the end.૮(˶ᵔ ᵕ ᵔ˶)ა 结对编程是与另一个开发者一起合作编写代码的过程。这种合作可以促进共同思考和学习，促进团队之间的知识共享和技能提升。并且两个人一起编程可以相互检查代码，减少错误和缺陷。通过结对编程，我可以提高代码质量、减少漏洞，并且在早期发现和纠正问题 软件工程实践总结──迄今为止最满意的成果 作为组长，审视一个组员是否优秀，没有想象中的那么容易。因为我不是他，他是否具备独立解决问题的能力还真不好考察──真说不来他解决问题是完全靠自己，还是问了 ChatGPT 得到了一个看似合理，但存在漏洞的答案。相较来看，和其他人协作的能力比较好考察，在开会时他的态度、在群里的发言等都可以反映出来。目前，我认为一名合格的程序员应当能融入团队，积极参与每一次讨论，贡献自己的想法；按时完成分配的任务，并及时向组长汇报完成情况 软件工程工实践总结–阳光总在风雨后 设计看似在项目中不起眼，但是真的值得我们花上大量的时间去完成，不仅仅是提供更好更清晰的展示，而且可以为后续的实现免去不必要的麻烦 挣脱束缚的一步——软件工程实践总结 对象池常使用于大量游戏对象的维护上。作为游戏优化的大头，其实现可以很简单也可以很复杂，这里举例说明多类型对象池的学习记录。此处对象池异于引用池。在Unity中使用常用的对象池时，需要理解对象池的的原理和Unity的生命周期，而此处的“坑”也和一种对象池的实现有关 软件工程实践总结——万变守其本,吾心持长青 α冲刺阶段是在先前准备完善的基础上进行正式的代码冲刺, 通过前期的几次合作磨合, α冲刺不管是在代码书写, 架构设计, 数据库设计上都变得更为容易、更加顺利, 组员在组长的带领下, 能够高效的完成自己的任务，发挥自己的能力，最终在α阶段结束时，我们已完成了任务大多数的内容，大大减轻了β冲刺的压力, 也是体现出前期准备的重要性 先进行部分模块测试可以节省时间。通常说来,我们在整合不同的模块时也会出现问题,例如模块之间的接口不匹配。但是如果我们能够信任各个组件的话，那么跟踪集成问题就会变得简单得多 投入足够的时间和资源进行全面的测试。包括单元测试、集成测试和系统测试，以确保代码的质量和系统的稳定性。自动化测试也是提高效率和减少人为错误的重要手段 测试工作通过对软件进行全面和严格的检验，可以发现软件存在的各种问题，以便及时修复和改进。这不仅确保软件达到高质量标准并满足需求，也推动软件不断完善和优化 设计阶段的工作十分关键而重要，相比需求阶段初步勾勒出产品雏形，设计阶段对软件进行全面而深入的设计，使软件变得更加具体、详细和全面 更多学长学姐的建议请查看他们的课程总结博客： 总结博客1 总结博客2 总结博客3 4.格式与规则 4.1、为了方便其他学校的老师或者助教了解课程实况，请大家在作业开头添加作业的基本信息：（必做） 这个作业属于哪个课程 <班级的链接> 这个作业要求在哪里 <作业要求的链接> 这个作业的目标 <写上具体方面> 其他参考文献 … markdown代码 这个作业属于哪个课程|<班级的链接>| |-- |-- | |这个作业要求在哪里|<作业要求的链接>| |这个作业的目标|<写上具体方面>| |其他参考文献|... | 4.2、为了方便阅读以及助教评分，请大家在博客开头给出博文目录，作为内容的索引 务必包含以下大标题：思维导图和学习路线（标题含义近似即可，你可以个性化自己的标题，如我的过去、我的简历、我的展望、学习计划） 可以使用markdown的语法[toc]，根据标题设置自动生成目录： @[toc] 作业基本信息... ## 回首过去 ### 问题1 ### 问题2 ### ... ## 立足当下 ... ## 展望未来 ... ## 思维导图和学习路线 ... 也可以结合html生成目录 作业基本信息... ## 目录： 1. [回首过去](#1) 2. [立足当下](#2) 3. [展望未来](#3) 4. [思维导图和学习路线](#4) ## <span id="1">1. 回首过去</span> ### 问题1 ### 问题2 ### ... ## <span id="2">2. 立足当下</span> ... ## <span id="3">3. 展望未来</span> ... ## <span id="4">4. 思维导图和学习路线</span> ... 4.3、作业提交规则 博客以班级作业页面的提交时间为准；需要提交的代码以codearts的提交时间为准； 博客需要在加入的社区中进行发布，请不要在个人账号中进行发布，另外，社区的文章编辑器和写文章的编辑器稍微有一些不同，请提交的时候查看清楚； 在这里插入图片描述 作业提交需要在对应作业下点击提交任务，上传对应的博客网页地址； 在这里插入图片描述 在这里插入图片描述 在deadline前交，分数为实际得分 ； 补交：在deadline 后两天内提交视为补交，分数为实际得分 * 50%；写了但是忘记提交作业和补交扣分一致 缺交：在deadline 之后两天未补交视为博客缺交，分数为0分； 注意事项：每次作业记得保留markdown原文件，防止部分图片等内容因为版权等问题无法显示，同时方便期末对每次作业的汇总，提交 4.4、作业计分规则 每次作业的基准分满分为100分，各次作业会以特定比例换算到学期成绩。比如： 某次作业，满分100分，以权重25%换算到学期总成绩 小李此次作业得分85分，作业在deadline前提交，那么他本次作业会以85*100%*25% = 21.25换算到总成绩中 小张此次作业得分85分，并是在deadline后的两天内补交，那么他本次作业会以85*50%*25% = 10.625换算到总成绩中 小王在作业deadline两天后还未补交，作业提交已经关闭，此次作业得0分 ... 4.5、其它规则 作业抄袭：当助教发现两篇博客文字/图片/代码过分相似时，判定两篇博客都为抄袭，该次作业不得分，并倒扣该次作业占总成绩比重的分数； 伪造提交：虽然作业博客没有完成，但是先提交到作业占位置，判定为伪造提交，分数得0分； 若需要在课程群填写相关信息，**未能在deadline之前完成填写的，扣实际得分的50%**； 微信班级群如果发布相关通知也是作业要求一部分，请及时查看群通知； 如对作业存在疑问，请在deadline之前三天在班级群提出； 若助教对作业要求有修改，会在群内公告，请务必查看并按新的要求完善作业； 🚨 特别提醒：去年有同学copy往期同学的思考成果，这是绝对不可取的行为！💢 一旦被发现将会被倒扣100分！实践出真知，请同学们务必要独立思考，才能有所收获！ 5.评分细则 【博客排版】(20%)：是否在博客开头给出了本次作业的基本信息；是否给出了博客内容目录；是否采用markdown排版，排版是否整齐，博客是否美观； 【思维导图和学习路线】(80%)：思维导图是否覆盖所有要求的内容，整齐美观；路线图是否详尽具有可行性 6.附录教程 1、markdown教程-Gitcode 2、markdown教程-菜鸟教程 3、华为云CodeArts学习使用视频 4、Git入门-华为云 5、Git学习-优快云 6、Xmind绘制思维导图教程
最新发布
09-22
我们使用Swagger定义API，大大提升了沟通效率，也让我意识到**良好的设计和文档是团队协作的基石**。 ### 问题2：你在学习新技术时遇到过哪些困难？如何克服？ 初学React时，对组件化思维和状态管理（如Redux）...
Swagger快速入门
11-06
Swagger的快速入门.文档中五部便可以将Swagger跑起来.
swagger2的使用
qq_44614137的博客
02-20 1213
swagger2
Swagger2介绍及使用
m0_67391521的博客
03-08 196
项目中整合Swagger2 1、什么是swagger2 2、常用注解 3、项目中整合Swagger2 3.1、引入Swagger2依赖 3.2、编写swgger2配置类代码 3.3、在需要测试的模块中引入有swagger2的模块坐标 3.4、使用swagger2测试 1、什么是swagger2 编写和维护接口文档是每个程序员的职责，根据Swagger2可以快速帮助我们编写最新的API接口文档，再也不用担心开会前仍忙于整理各种资料了，间接提升了团队开发的沟通效率。 2、常用注解 swagger通过
swagger2 介绍+注解说明
.
01-10 7679
swagger接口文档API优势: 1.支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便。 2.提供 Web 页面在线测试 API：有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。
深度探索Swagger2：从介绍到多环境应用
2201_75869073的博客
12-20 1128
Swagger2是一种用于设计、构建和文档化RESTful API的工具，它使用简单的注解来描述API的结构和功能。通过Swagger2，开发者可以轻松地生成交互式的API文档，并且可以直接在文档中进行API的调试和测试。通过本文的介绍，读者可以全面了解Swagger2的介绍、基本应用以及多环境应用。Swagger2作为一种强大的RESTful API文档化工具，为开发者提供了便捷的方式来描述、调试和测试API，极大地提高了开发效率和API的可维护性。
Swagger的原理及应用详解（一）
凛鼕将至的博客
07-02 2263
Swagger（OpenAPI Specification）是一个功能强大的框架和规范，它通过自动化生成文档、提供详细的API描述以及支持调用和可视化等功能，极大地简化了API的设计、构建、使用和理解过程。无论是在企业内部还是跨企业的API合作中，Swagger都发挥着重要的作用。
Swagger使用的详细教程
mkmmkkghhhhhhhh的博客
01-15 1万+
swager的详细使用，及其空指针bug解决
swagger简介
热门推荐
weixin_52639224的博客
03-11 1万+
一、swagger的作用 根据在代码中使用自定义的注解来生成接口文档，这个在前后端分离的项目中很重要。这样做的好处是 在开发接口时可以通过swagger将接口文档定义好，同时也方便以后的维护。 在没有swagger之前，我们可以使用word，excel等功能来书写接口定义文档，但又有一个弊端，即： 在接口发送改变时需要及时的同步接口文档，否则实际的接口与接口文档不相符，则接口文件就失去了作用，甚至会起到反作用。 二、swagger的优点 号称时最流行的API框架 接口文档在线生成.
Swagger
weixin_45969711的博客
11-09 276
系列文章目录 Swagger是一款目前世界最流行的API管理工具。目前Swagger已经形成一个生态圈，能够管理API的整个生命周 期，从设计、文档到测试与部署。Swagger有几个重要特性： 代码侵入式注解 遵循YAML文档格式 非常适合三端（PC、iOS及Android）的API管理，尤其适合前后端完全分离的架构模式。 减少没有必要的文档，符合敏捷开发理念 功能强大 Swagger系列文章目录前言一、简介二、配置Swagger三、常用注解四、使用 前言 本文比较详细的介绍Swagger工具
Swagger2自学项目：全面笔记解析
- springfox-swagger2：核心库，提供文档生成的相关注解。 - springfox-swagger-ui：前端展示和测试 API 的界面。 - 其他语言也有相应的库和工具支持。 2. 配置 Swagger 通过配置类或配置文件来启用 Swagger，并且...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值