SpringBoot(7)-Swagger

目录

一、是什么

二、SpringBoot集成Swagger

三、配置Swagger

[3.1 配置文档信息](#3.1 配置文档信息)

[3.2 配置扫描接口](#3.2 配置扫描接口)

[3.3 配置Swagger开关](#3.3 配置Swagger开关)

[3.4 配置API分组](#3.4 配置API分组)

[3.5 实体配置](#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、可以在线测试

相关推荐
前端小万2 分钟前
思考,行动,复盘|2026
前端·后端·面试
ikgy5 分钟前
JAVA EE:4.多线程核心组件实战
java·java-ee
杨凯凡13 分钟前
IT日报|2026-11-19:Oracle Java 紧急补丁、Optimizely 供应链攻击、GitHub 安全评估升级
java·oracle·github
Sailing28 分钟前
🚀客户端都超时了,你的 Go 服务还在查库?Context 取消链路不打通,连接池迟早被打爆
后端·面试·go
拖孩41 分钟前
# 我又用 AI 做了个小程序:24 天,记录我这辈子认识的人
前端·后端·微信小程序
Csvn1 小时前
Nginx rewrite 与 server_name:last/break 语义、多域名匹配与伪静态
后端·nginx
JasonChen@6661 小时前
2.Tomcat 安装部署与一键自动化脚本实战
java·tomcat
AAA修煤气灶刘哥1 小时前
32 GB 内存跑起 1800 亿参数模型,代价是什么?
人工智能·后端·架构
SimonKing2 小时前
零 OCR 依赖!Firecrawl 这个 Rust 库把 Word / PPT / Excel 全变成 Markdown
java·后端·程序员
Rain的Java大神之路2 小时前
别被 ChatGPT 的打字机效果骗了:一字一字蹦,才是 LLM 自回归的命门(附大厂 Java 流式落地)
java·后端·面试