当前位置:网站首页 > R语言数据分析 > 正文

swagger2注解(swagger2注解无效)



创建一个Controller,定义一个接口,讲述Swagger2的常用注解


@Api【定义Controller请求类】

 

@Api 注解的主要作用是对Controller,也可以称之为对请求类做一个描述,它有几个常用参数,下面解释一下它们的用处

参数名 描述 tags 用于表示该请求类在文档中的 标签名称 description 详细描述 position 设置该请求类在文档中的位置顺序 protocols 协议类型,如: http, https hidden 该文档是否隐藏,默认为tree

效果图:

在这里插入图片描述



@ApiOperation【描述接口说明

 

@ApiOperation 注解的主要是对接口做出描述,它有几个常用参数,下面解释一下它们的用处

参数名 描述 value 描述接口的作用 notes 接口的备注

效果图:

在这里插入图片描述



@ApiImplicitParams【接口的一组入参参数】、@ApiImplicitParam【描述接口中单个参数说明】

 

@ApiImplicitParams 注解的作用就是描述接口中多个参数

@ApiImplicitParam 是描述单个参数说明,它有几个常用参数,下面解释一下它们的用处

参数名 描述 name 参数名 value 参数备注 required 该参数是否必穿 paramType 参数放在哪个地方【path(restful接口)、query、body、header、form】 dataType 参数数据类型 defaultValue 参数默认值

效果图:

在这里插入图片描述



@ApiResponses【一组响应状态码与描述】、@ApiResponse【响应状态码与描述】

 

@ApiResponses 注解的作用就是描述接口多个响应状态

@ApiResponse 是单个响应状态码与描述,它有几个常用参数,下面解释一下它们的用处

参数名 描述 code 响应状态码 message 响应说明

效果图:

在这里插入图片描述



@ApiModel【描述入参对象与出参对象】、@ApiModelProperty【描述对象中单个参数】

 

返回对象:

 

@ApiModel 注解的作用是描述入参与出参对象

@ApiModelProperty 是描述单个参数,它有几个常用参数,下面解释一下它们的用处

参数名 描述 value 参数名 required 参数是否必传 position 参数在文档中的位置

效果图:

在这里插入图片描述





End











到此这篇swagger2注解(swagger2注解无效)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!
























































版权声明


相关文章:

  • 手表crnaira是什么牌子多少钱的?(手表carrera是什么牌子)2026-04-02 15:54:10
  • ueditor官网文档(ueditorapi文档)2026-04-02 15:54:10
  • 查看docker版本号(docker lastest 怎么查具体版本号)2026-04-02 15:54:10
  • swagger2配置不生效(swagger.enable)2026-04-02 15:54:10
  • enoent no such file or 打包报错(no package file selected)2026-04-02 15:54:10
  • spring教程 csdn(spring教程百度网盘)2026-04-02 15:54:10
  • airplay是什么意思啊(airplay在哪里打开)2026-04-02 15:54:10
  • gridview 居中(gridviewrow)2026-04-02 15:54:10
  • druid监控页面分析(druid监控页面springboot)2026-04-02 15:54:10
  • airplay安卓(airplay安卓端下载)2026-04-02 15:54:10
  • 全屏图片