计算机系统应用教程网站

网站首页 > 技术文章 正文

日志记录-swagger注释

btikc 2024-09-14 00:44:02 技术文章 9 ℃ 0 评论

mysql出现报错:

Could not set property 'customerId' of 'class cn.stylefeng.guns.modular.system.model.ProCustomer' with value '1166901559745884161'

问题:customer表中没有设置自增,而且字段类型为int(11),那么1166901559745884161这个值是从哪里来的

解决:实体类中没有添加注释,在@TableField(value="table_id",type=idType.AUTO)

swagger接口文档注释,

重构接口方法,按照reseful风格来进行注释,put,delete,post,get对应增删改查

在增删改查方法中,只有删方法,只需用到主键好进行注解,但是一旦使用实体性对象进行接收前端参数,后端是知道自己需要的是哪些参数,但是前端就不知道对应的参数,所以需要在接口文档中进行说明,但是在接口文档中默认出现接口方法的参数对象,

这不是我们想见到的。

试想方式:

1.为参数添加required=true属性,并告诉前端,怎么看接口文档

这种方式,出现的问题是对应属性和对象都出现,但是,实际并没有请求这个参数,当前属性参数只是对象属性,没有实际存在,所以swagger会报错

问题:需要让swagger识别到这几个参数是对象中的属性

2.如果swagger可以去掉这种默认出现的参数,并可以在参数中添加说明,则最好

使用注解@ApiParam(hidden = true),隐藏请求参数

参考文档:https://blog.csdn.net/jiangyu1013/article/details/83107255

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表