swagger的使用

本文详细介绍如何在项目中使用Springfox集成Swagger2,包括在pom文件中添加依赖、启用Swagger2、访问生成的API文档,以及如何通过注释增强文档的可读性和功能性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.首先在pom文件中添加如下依赖

<!--生成数据-->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.7.0</version>
</dependency>
<!--生成文档-->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.7.0</version>
</dependency>

2.在启动类上加上 @EnableSwagger2

3.启动项目,访问http://localhost:8082/reed/swagger-ui.html,将会列出系统中所有的controller

---------

一些技巧

1.在方法前面加上

@ApiOperation(value = "查询部门所有信息"),则表明此方法的作用为查询部门所有信息,效果如下图

2.给封装的查询条件加注释,如下图

效果如下图所示

 

对未封装的属性加注释

效果如下图

----

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值