关于swagger

1.关于swagger 的前置学习

先参考:
SpringBoot(七)在SpringBoot中集成swagger2_ifknow-CSDN博客_springboot swagger
https://blog.csdn.net/qq_41373681/article/details/108123986
注:由于jar包的冲突,建议直接使用博客中的第二种办法,小刀项目jar

2. 快速使用

2.1 @Api — 类上

@Api(value = “/sample/users”, description = “gets some data from a servlet”, consumes=“application/json, application/xml”)
public class SampleServlet extends HttpServlet {

}

2.2 @ApiOperation – 方法上

@GET
@Path("/findByStatus")
@ApiOperation(value = “Finds Pets by status”,
notes = “Multiple status values can be provided with comma seperated strings”,
response = Pet.class,
responseContainer = “List”)
public Response findPetsByStatus(…) { … }

2.3 @ApiModelProperty – 在实体类的字段或方法上

测试发现, 注解里 name这个很重要,不可乱起名字,
比如我id字段注解里起了个iddd,即使传了值,但是bean的id字段上也没有值。 甚至我改成了state,直接给字段state传上了值(虽然它是id字段的注解)
在这里插入图片描述

2.3 其他

定义在类上:@Api

定义在方法上:@ApiOperation

定义在参数上:@ApiParam

3. 例子

每个注解的 可选项比较多,一般项目不需要这么多,简单点如:
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值