spring swagger中参数为实体类的怎么注解

spring swagger中参数为实体类的怎么注解,第1张

1、首先@Entity注解加在实体类上,定义对象将会成为被JPA管理的实体,将映射到指定的数据库。

2、一般自增主键的名字都会用id来表示,@Id注解表名是表的自增主键,一个实体里只能又一个。

3、@IdClass注解可以实现一个实体类中有两个主健,即联合主健。首先需要创建一个联合主健类并且实现序列化接口,类名为TeacherBlogKey,该类中有id和studentId这两个字段。

4、@Basic表示属性到数据库字段的映射,实体类的属性不加任何注解的时候默认是@Basic注解。

5、最后如果实体类中的一个属性并不想和数据库中的字段做映射的话,可以使用@Transient注解,这个注解表示非持久化属性,与@Basic注解的作用相反,JPA映射数据库的时候会忽略它。

@ TOC

api 标记,用在类上,说明该类的作用。可以标记一个 Controller 类做为 Swagger 文档资源,使用方式

与 Controller 注解并列使用。 属性配置:

tags 一定要写,不然swagger扫描显示的是类名

ApiOperation 标记,用在方法上,说明方法的作用,每一个 url 资源的定义,使用方式:

与 Controller 中的方法并列使用,属性配置:

ApiParam 标记,请求属性,使用方式:

与Controller中的方法并列使用,属性配置:

ApiResponse 标记,响应配置,使用方式:

与 Controller 中的方法并列使用,属性配置:

ApiResponses 标记,响应集配置,使用方式:

与 Controller 中的方法并列使用,属性配置:

ResponseHeader 标记,响应头设置,使用方法

与 Controller 中的方法并列使用,属性配置:

其中@Null、@NotNull。。等与@Valiated 配合使用

用在返回对象类上

用在返回对象的属性上

@Api(tags = "")写,不然swagger扫描显示的是类名

持续更新中。。。。


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/bake/11905936.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-19
下一篇 2023-05-19

发表评论

登录后才能评论

评论列表(0条)

保存