news 2026/4/16 13:51:10

SpringBoot(7)-Swagger

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
SpringBoot(7)-Swagger

目录

一、是什么

二、SpringBoot集成Swagger

三、配置Swagger

3.1 配置文档信息

3.2 配置扫描接口

3.3 配置Swagger开关

3.4 配置API分组

3.5 实体配置

四、常用注解

五、总结


一、是什么

是一款API框架,API文档和API定义同步更新,可以在线测试API

二、SpringBoot集成Swagger

1、新建一个springboot-web项目

2、导入相关依赖**(swagger2、swagger-ui)**

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>

3、编写HelloWorld

4、配置swagger

5、测试运行

访问测试 :http://localhost:8080/swagger-ui.html,可以看到swagger的界面

三、配置Swagger

3.1 配置文档信息

1、Swagger的实例bean是Docket

2、通过docket的apiInfo()属性配置文档信息

3、Docket实例关联上apiInfo属性

4、重启项目,访问测试效果

3.2 配置扫描接口

1、通过select()方法配置怎么扫描接口

3.3 配置Swagger开关

1、通过enable()方法配置是否启用(true启用,false不启用)

2、若要实现处于test、dev环境时显示swagger,处于prod环境时不显示

3.4 配置API分组

1、若没有配置分组,默认是default。可通过groupName()方法进行分组配置

2、配置多个分组,只需要配置多个docket即可

3.5 实体配置

1、新建一个实体类User

2、只要接口的返回值中存在实体类,就会被扫描到swagger中

3、测试

四、常用注解

作用:给一些比较难理解的属性或者接口,增加一些配置信息,方便阅读!

五、总结

1、我们可以给一些比较难理解的属性或接口,增加注释信息

2、接口文档实时更新

3、可以在线测试

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/16 12:31:27

思源宋体完全使用宝典:7步打造专业中文排版

思源宋体完全使用宝典&#xff1a;7步打造专业中文排版 【免费下载链接】source-han-serif-ttf Source Han Serif TTF 项目地址: https://gitcode.com/gh_mirrors/so/source-han-serif-ttf 思源宋体是由Google和Adobe联合开发的开源中文字体&#xff0c;提供了从极细到超…

作者头像 李华
网站建设 2026/4/16 10:41:47

Godot卡牌游戏框架完整指南:快速构建专业级卡牌游戏

Godot卡牌游戏框架完整指南&#xff1a;快速构建专业级卡牌游戏 【免费下载链接】godot-card-game-framework A framework which comes with prepared scenes and classes to kickstart your card game, as well as a powerful scripting engine to use to provide full rules …

作者头像 李华
网站建设 2026/4/16 12:16:21

ExifToolGUI终极指南:5分钟快速掌握专业级元数据编辑

ExifToolGUI终极指南&#xff1a;5分钟快速掌握专业级元数据编辑 【免费下载链接】ExifToolGui A GUI for ExifTool 项目地址: https://gitcode.com/gh_mirrors/ex/ExifToolGui 想要轻松管理照片和视频的元数据信息吗&#xff1f;ExifToolGUI作为ExifTool的图形界面版本…

作者头像 李华
网站建设 2026/4/16 10:38:45

Android设备音频同步到电脑的完美解决方案:Escrcpy实战指南

Android设备音频同步到电脑的完美解决方案&#xff1a;Escrcpy实战指南 【免费下载链接】escrcpy &#x1f4f1; Graphical Scrcpy to display and control Android, devices powered by Electron. | 使用图形化的 Scrcpy 显示和控制您的 Android 设备&#xff0c;由 Electron …

作者头像 李华
网站建设 2026/4/16 11:08:34

暗黑3智能宏革命:5分钟掌握D3KeyHelper高效操作秘籍

暗黑3智能宏革命&#xff1a;5分钟掌握D3KeyHelper高效操作秘籍 【免费下载链接】D3keyHelper D3KeyHelper是一个有图形界面&#xff0c;可自定义配置的暗黑3鼠标宏工具。 项目地址: https://gitcode.com/gh_mirrors/d3/D3keyHelper 还在为暗黑3中繁琐的技能循环而手忙脚…

作者头像 李华
网站建设 2026/4/15 22:47:52

GTA V智能辅助伴侣:YimMenu全新体验指南

GTA V智能辅助伴侣&#xff1a;YimMenu全新体验指南 【免费下载链接】YimMenu YimMenu, a GTA V menu protecting against a wide ranges of the public crashes and improving the overall experience. 项目地址: https://gitcode.com/GitHub_Trending/yi/YimMenu YimM…

作者头像 李华