ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

Swagger常用注解实验

2022-01-28 23:01:03  阅读:179  来源: 互联网

标签:常用 样例 value 说明 ApiParam 用于 注解 Swagger 方法


@Api() 用于类 表明此类为swagger资源

  • value url的路径值
  • tags 如果设置这个值、value的值会被覆盖

image-20220128205957209

image-20220128210038536

@ApiOperation() 用于方法 说明方法的作用,每个URL资源的定义、

  • value 方法描述
  • notes 提示内容
  • tags 可重新分组(选用)

image-20220128210855336

image-20220128211012902

@ApiParam() 用于方法、参数、字段说明

  • name 参数名称
  • value 参数说明
  • required 是否必填
  • example 样例说明

image-20220128213555248

image-20220128213626946

@ApiModel() 用于Post中表单的实体类

  • value 对象名
  • description 描述

常用于使用通过@RequestBody来提交表单的场景

image-20220128214752333

image-20220128215042476

@ApiModelProperty() 用于方法 、字段 对实体类属性进行说明

  • value 字段说明
  • name 字段名字
  • dataType 重写属性类型(非必须不用加)
  • required 是否必填
  • example 样例
  • hidden 隐藏

image-20220128224718872

image-20220128224939283

通过该注解,在提交Body数据时,会提供详细的关于字段的解释以及正确的样例

@ApiImplicitParam() @ApiImplicitParams()

功能和@ApiParam(),一般情况下使用@ApiParam即可

标签:常用,样例,value,说明,ApiParam,用于,注解,Swagger,方法
来源: https://blog.csdn.net/m0_52038897/article/details/122737763

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有