news 2026/4/15 9:11:52

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/15 7:36:36

ExifToolGUI完全指南:从入门到精通元数据管理

ExifToolGUI完全指南&#xff1a;从入门到精通元数据管理 【免费下载链接】ExifToolGui A GUI for ExifTool 项目地址: https://gitcode.com/gh_mirrors/ex/ExifToolGui 想要轻松管理照片和视频的元数据信息吗&#xff1f;ExifToolGUI正是你需要的工具&#xff01;这款强…

作者头像 李华
网站建设 2026/4/8 21:22:32

ComfyUI-Easy-Use节点连接线残留问题的完整解决方案

ComfyUI-Easy-Use节点连接线残留问题的完整解决方案 【免费下载链接】ComfyUI-Easy-Use In order to make it easier to use the ComfyUI, I have made some optimizations and integrations to some commonly used nodes. 项目地址: https://gitcode.com/gh_mirrors/co/Comf…

作者头像 李华
网站建设 2026/4/8 19:19:20

Android Studio中文界面终极配置指南:快速实现母语开发环境

Android Studio中文界面终极配置指南&#xff1a;快速实现母语开发环境 【免费下载链接】AndroidStudioChineseLanguagePack AndroidStudio中文插件(官方修改版本&#xff09; 项目地址: https://gitcode.com/gh_mirrors/an/AndroidStudioChineseLanguagePack 还在为And…

作者头像 李华
网站建设 2026/4/15 6:40:55

Windows 12网页版终极体验指南:免费打造你的云端操作系统

Windows 12网页版终极体验指南&#xff1a;免费打造你的云端操作系统 【免费下载链接】win12 Windows 12 网页版&#xff0c;在线体验 点击下面的链接在线体验 项目地址: https://gitcode.com/gh_mirrors/wi/win12 想要在浏览器中零成本体验下一代Windows操作系统吗&…

作者头像 李华
网站建设 2026/4/15 6:43:11

Free-NTFS-for-Mac:突破苹果系统NTFS读写限制的专业解决方案

Free-NTFS-for-Mac&#xff1a;突破苹果系统NTFS读写限制的专业解决方案 【免费下载链接】Free-NTFS-for-Mac Nigate&#xff0c;一款支持苹果芯片的Free NTFS for Mac小工具软件。NTFS R/W for macOS. Support Intel/Apple Silicon now. 项目地址: https://gitcode.com/gh_m…

作者头像 李华
网站建设 2026/4/15 6:41:36

电视盒子改造终极指南:200+设备Armbian系统完整支持清单

电视盒子改造终极指南&#xff1a;200设备Armbian系统完整支持清单 【免费下载链接】amlogic-s9xxx-armbian amlogic-s9xxx-armbian: 该项目提供了为Amlogic、Rockchip和Allwinner盒子构建的Armbian系统镜像&#xff0c;支持多种设备&#xff0c;允许用户将安卓TV系统更换为功能…

作者头像 李华