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、可以在线测试

相关推荐
象牙塔五六七22 分钟前
Java 泛型精讲:从 Stream 源码说起
后端
掘金挖土23 分钟前
前端手摸手跑路之 AI 应用开发(十二)
前端·后端
程序员cxuan24 分钟前
GPT-6.2 Astra 发布了,但口碑崩了。。。
人工智能·后端·程序员
象牙塔五六七25 分钟前
Java 函数式编程精讲:从 Stream 源码说起 —— 用真实源码学懂函数式思维
后端
字节跳动数据库39 分钟前
火山引擎缓存数据库:如何构建超大规模缓存集群的无感弹性能力
数据库·人工智能·后端
小满、39 分钟前
Java 值传递
java·java 值传递
IT枫斗者枫哥40 分钟前
Java 异步导出只测最终行数,为什么下载时仍会少一行?
java·后端
用户78506119579741 分钟前
不会前端,我靠 AI 和 Python 做了一个 4K 壁纸站
后端
噜噜学上位机42 分钟前
什么是多态?
后端
站大爷IP1 小时前
Python的类方法把我坑惨了,原来@classmethod和@staticmethod的区别这么大
后端