swagger隐藏实体类字段_Swagger 常用注解

常用注解: - @Api()用于类; 表示标识这个类是swagger的资源 - @ApiOperation()用于方法; 表示一个http请求的操作 - @ApiParam()用于方法,参数,字段说明; 表示对参数的添加元数据(说明或是否必填等) - @ApiModel()用于类 表示对类进行说明,用于参数用实体类接收 - @ApiModelProperty()用于方法,字段 表示对model属性...
摘要由CSDN通过智能技术生成

常用注解:
- @Api()用于类;
表示标识这个类是swagger的资源
- @ApiOperation()用于方法;
表示一个http请求的操作
- @ApiParam()用于方法,参数,字段说明;
表示对参数的添加元数据(说明或是否必填等)
- @ApiModel()用于类
表示对类进行说明,用于参数用实体类接收
- @ApiModelProperty()用于方法,字段
表示对model属性的说明或者数据操作更改
- @ApiIgnore()用于类,方法,方法参数
表示这个方法或者类被忽略
- @ApiImplicitParam() 用于方法
表示单独的请求参数
- @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam

具体使用举例说明:
@Api()
用于类;表示标识这个类是swagger的资源
tags–表示说明
value–也是说明,可以使用tags替代
但是tags如果有多个值,会生成多个list

@Api(value="用户controller",tags={"用户操作接口"})

@RestController

public class UserController {

}

效果图:

  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
要快速基于数据库表生成实体类并自动加上swagger注解,可以采取以下步骤: 1. 首先,需要连接数据库,并读取数据库表的结构信息。可以使用数据库连接工具库如JDBC来连接数据库,使用相关API获取表的元数据信息。 2. 获取表的元数据后,可以通过遍历元数据来生成实体类。可以使用字符串拼接的方式,构建出实体类的代码。 3. 在生成实体类的过程中,需要根据元数据的类型和名称来决定实体类字段类型和名称。根据元数据的类型,可以将数据库的数据类型转换为对应的Java类型。使用字符串拼接的方式,可以将字段类型、名称及其注解添加到实体类的代码中。 4. 在实体类中加入swagger注解,可以通过在生成实体类代码的过程中,根据表的元数据信息,判断是否应该添加swagger注解。根据元数据的属性,可以判断字段是否为必填项、字段的描述等。根据这些元数据属性,可以通过字符串拼接,将swagger注解的相关信息添加到实体类代码中。 5. 完成实体类的生成之后,可以将生成的实体类保存到指定的路径。可以使用IO操作将生成的代码保存为Java文件。 6. 最后,通过编译器编译生成的Java文件,将其转换为字节码文件,并加载到JVM中即可。 通过以上步骤,可以快速基于数据库表生成实体类,并自动加上swagger注解。这样可以方便地生成实体类代码,并为API文档的编写提供便利。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值