swagger-@ApiModelProperty

最新推荐文章于 2024-02-27 14:15:49 发布
最新推荐文章于 2024-02-27 14:15:49 发布
阅读量6.8k 收藏 2
点赞数
分类专栏： swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zym_1321/article/details/96148285
版权

@ApiModelProperty(value = “”, example = “”, position = 1)

value(String)
此属性的可读概要

example(String)
举例

position(int)
在模型中显式排序属性。

required(boolean)
无论属性是否必需，默认为false。

access(String)
指定一个可选的访问值，以便在Filter实现中进行过滤。

allowableValues(String)
如果可以设置的值受到限制，则可以在此处设置它们。

dataType
支持的数据类型

hidden(boolean)
允许在swagger模型定义中将模型属性标记为隐藏

notes(String)
长描述

name(String)
重写属性名字

程序小白-M
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger-tool：springfox-swagger工具，目的是减少swagger注解生成。当前只支持IDEA。个人觉得不妥，所以替换了自动生成@ApiModelProperty的方案1，把model中的* xxx注解转换成@ApiModelProperty（“ xxx”）
02-24
招摇工具 介绍 spring仅有的IDEA。本来打算直接修改springfox的源码，但是编译后的类文件没有注释，要实现需要把源码打进包包，这种方式个人觉得不妥当，因此改为了自动生成@ApiModelProperty的方案 功能 1，*把模型中的/ xxx /注解转换成@ApiModelProperty（“ xxx”），可以自定义转换词组，也可以使用翻译 2，一键生成对象的设置方法 3，一键复制完整的restful地址，支持SpringMvc和Feign 安装教程 方法一：在IDEA marketplace中搜索swagger-annotation-tool安装。IDEA->设置-> Marketplace中搜索swagger-annotation-tool 方法二：在release中下载 下载地址： : 方法三：自己编译生成jar文件 介绍IDEA 将打包后jar以本地插件方式安装
@ApiModelProperty注解的用法(官方平台推荐文章)
热门推荐
weixin_44356055的博客
11-02 15万+
1、value() 源码：String value() default ""; 参数类型为String，作用为此属性的简要描述。 2、name() 源码： String name() default ""; 参数类型为String，作用为允许重写属性的名称。 3、allowableValues() 源码：String allowableValues() default ""; 参数类型为String，作用为限制此参数存储的长度。 4、access() 源码：String access()
Swagger3 使用详解
最新发布
初心不忘、始终方得
02-27 2629
swagger使用快速入门到实战
项目一：学习笔记
weixin_50268501的博客
04-25 179
1、spring注解 2、java项目的层次 3、ssm框架 4、mapper中的各个标签
Validator检验框架的使用
weixin_39793646的博客
08-03 6212
Validator一般用来验证前端页面传过来的数据 是否符合预期   首先在需要检验的pojo中对需要检验的属性加相关注解如下： package com.aekc.mmall.param; import org.hibernate.validator.constraints.Email; import org.hibernate.validator.constraints.Length;...
使用@ApiModel和@ApiModelProperty的技巧
m0_73898769的博客
12-15 1188
在现代软件开发中，提供清晰全面的至关重要。@ApiModel和这样的代码注解在此方面表现出色，通过增强模型及其属性的元数据来丰富文档内容。它们的主要功能是为这些元素命名和描述，使生成的 API 文档更加明确。@ApiModel。
Swagger 注解 @ApiModelProperty 的作用
yunyala的博客
09-05 1093
在上面的示例中，通过 @ApiModelProperty 注解为 User 类的属性添加了描述信息。例如，id 属性被描述为 “用户ID”，username 属性被描述为 “用户名”，age 属性被描述为 “用户年龄”。在使用 @ApiModelProperty 注解时，你可以在属性上方添加该注解，指定属性的描述、数据类型、是否必需等信息。@ApiModelProperty 是 Swagger 的注解之一，用于在生成的 API 文档中定义和描述接口的属性信息。
swagger常用注释API @ApiModel、@ApiModelProperty的用法
zhangkai__的博客
07-03 2838
swagger常用注释API @ApiModel、@ApiModelProperty的用法
Swagger注解-@ApiModel 和 @ApiModelProperty
dejunyang的博客
04-27 13万+
@ApiModel 使用场景 在实体类上边使用，标记类时swagger的解析类 概述 提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省 属性 属性名称 数据类型 默认值 说明 value String 类名 为模型提供备用名称 description String “” 提供详细的类描述 parent Class<?> parent Void...
swagger中@ApiModelProperty修改文档不生效问题踩坑实录
weixin_43401380的博客
01-30 4630
小美同学又挖坑,填坑过程好漫长,但是也算有收获,记录swagger中@ApiModelProperty修改文档不生效问题实录,平常不仔细绝对会踩坑!
@ApiModelProperty注解的用法
weixin_44821114的博客
08-28 1351
@ApiModelProperty是swagger的注解，它的作用是添加和操作属性模块的数据
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
springBoog和Swagger2使用的接口注解
01-28
springBoog和Swagger2使用的接口注解，自己整理的注解使用说明
java版商城源码下载-Swagger-Bootstrap-UI:基于SpringBoot的API接口文档管理界面项目
06-05
@ApiModelProperty(name = "id", position = 0, value = "项目编号[添加操作可不传递,修改必传]", extensions = { // 存在与hiddenList中的路径,在展示和这个路径相关的接口时,会触发这里面的hidden方法 @...
Swagger3 API接口文档规范课程（教学视频+源代码）
02-09
3.3 实例二 `@ApiModel` , `@ApiModelProperty` 实体参数描述 3.4 实例三 `@ApiResponses` ， `@ApiResponse` 4 Swagger3 接口测试 5 Swagger3 API信息配置 6 Swagger3 Docket 开关&过滤&分组 配置详解 6.1 开关设置...
swagger注解
sproutBoy的博客
04-12 397
1. @Api 用于类；表示标识这个类是swagger的资源 tags–表示说明 value–也是说明，可以使用tags替代 Controller1 @Api(value = "demo1测试",tags = "测试Controller1") @RestController @RequestMapping("demo/one/controller") public class DemoOn...
swagger @ApiModel @ApiModelProperty注解属性说明
闲走天涯的博客
04-02 1万+
@ApiModel 使用场景：在实体类上边使用，标记类时swagger的解析类。 概述：提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省。 用法： @ApiModel(value = “ShopVo”, description = “商铺信息”) @ApiModelProperty 使用场景：使用在被 @ApiModel 注解的模型类的属性上。表示对model属性的说明或者数据操作更改 。 概述：添加和操作模型属性的数据。 用法： @ApiModelProperty(value = “
Swagger 大坑 之 @ApiModelProperty 注解的大坑
m0_37856386的博客
03-16 3415
swagger页面上突然少了一个接口集：@ApiModelProperty注解是不能修饰public修饰的类属性的；
swagger整合，导入，配置，配置匹配策略，@Api，@ApiOperation，@ApiModel，@ApiModelProperty，@ApiImplicitParam，@ApiParam
qq120631157的博客
05-01 3028
swagger整合，导入，配置，配置匹配策略，@Api，@ApiOperation，@ApiModel，@ApiModelProperty，@ApiImplicitParam，@ApiParam
swagger中 @ApiModelProperty的作用和参数说明
01-31
@ApiModelProperty是Swagger框架中的一个注解，用于对模型类的属性进行说明或者数据操作更改。它可以用来描述属性的含义、数据类型、是否必填等信息。 @ApiModelProperty的参数说明如下： - value：属性的简要描述。 - name：属性的名称。 - dataType：属性的数据类型。 - required：属性是否为必填项。 - example：属性的示例值。 - hidden：属性是否在Swagger文档中隐藏。 下面是一个示例： ```java @ApiModel(value = "User", description = "用户信息") public class User { @ApiModelProperty(value = "用户ID", example = "1") private Long id; @ApiModelProperty(value = "用户名", required = true) private String username; @ApiModelProperty(value = "年龄", dataType = "int") private int age; // 省略其他属性和方法 } ``` 在上面的示例中，@ApiModelProperty注解被用于描述User类的属性。例如，id属性被描述为用户ID，age属性被描述为年龄。同时，还可以指定属性的数据类型、是否必填以及示例值等信息。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值