swagger2 注解说明 ( @ApiImplicitParams )

swagger2 注解说明 ( @ApiImplicitParams )Api 用在请求的类上 表示对类的说明 tags 说明该类的作用 可以在 UI 界面上看到的注解 value 该参数没什么意义 在 UI 界面上也看到 所以不需要配置 ApiOperation 用在请求的方法上 说明方法的用途 作用 value 说明方法的用途 作用 notes 方法的备注说明 ApiImplicitP 用在请求的方

 

 前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家。点击跳转到教程。

@Api:用在请求的类上,表示对类的说明 tags="说明该类的作用,可以在UI界面上看到的注解" value="该参数没什么意义,在UI界面上也看到,所以不需要配置" @ApiOperation:用在请求的方法上,说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明" @ApiImplicitParams:用在请求的方法上,表示一组参数说明 @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面 name:参数名 value:参数的汉字说明、解释 required:参数是否必须传 paramType:参数放在哪个地方 · header --> 请求参数的获取:@RequestHeader · query --> 请求参数的获取:@RequestParam · path(用于restful接口)--> 请求参数的获取:@PathVariable · body(不常用) · form(不常用) dataType:参数类型,默认String,其它值dataType="Integer" defaultValue:参数的默认值 @ApiResponses:用在请求的方法上,表示一组响应 @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息 code:数字,例如400 message:信息,例如"请求参数没填好" response:抛出异常的类 @ApiModel:用于响应类上,表示一个返回响应数据的信息 (这种一般用在post创建的时候,使用@RequestBody这样的场景, 请求参数无法使用@ApiImplicitParam注解进行描述的时候) @ApiModelProperty:用在属性上,描述响应类的属性
@Api(tags="APP用户注册Controller")
@ApiOperation(value="用户注册",notes="手机号、密码都是必输项,年龄随边填,但必须是数字")

示列:

@ApiImplicitParams({     @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),     @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),     @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer") })
@ApiOperation(value = "select1请求",notes = "多个参数,多种的查询参数类型") @ApiResponses({     @ApiResponse(code=400,message="请求参数没填好"),     @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对") })
import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @ApiModel(description= "返回响应数据") public class RestMessage implements Serializable{     @ApiModelProperty(value = "是否成功")     private boolean success=true;     @ApiModelProperty(value = "返回对象")     private Object data;     @ApiModelProperty(value = "错误编号")     private Integer errCode;     @ApiModelProperty(value = "错误信息")     private String message;     /* getter/setter */ }

 

 

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/231688.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • 计算机发展史的故事_了解计算机的发展史

    计算机发展史的故事_了解计算机的发展史核心提示:男人去嫖娼,就如你下馆子吃饭一样没多大区别,也没有多复杂的动机。男人自己的性欲和食欲一样,是无关感情爱情的。但几乎所有男人都明了:女人如果心甘情愿被人压在下面,这事关女人的感情。男人能把性和爱分开,而女人很难做到。计算工具的演化经历了由简单到复杂、从低级到高级的不同阶段,如从“结绳记事”中的绳结到算筹、算盘计算尺、机械计算机等。它们在不同的历史时期发挥了各自的历史作用,同时也启发了现代电…

    2022年10月19日
    3
  • 查看mysql端口_如何查看db2数据库的端口

    查看mysql端口_如何查看db2数据库的端口mysql端口号(怎么查看mysql的端口号)2020-05-0721:54:58共10个回答如何查看mysql的端口号1使用命令showglobalvariableslike’port’;查看端口号2修改端口,编辑/etc/my.cnf文件,早期版本有可能是my.conf文件名,增加端口参数,并且设定端口,注意该端口未被使用,保存退出.总结:注意修改的端口不要被占用,而且要有规划,不要轻意的总…

    2022年10月3日
    3
  • 统计学的卡方检验方法是什么呢?用几个生活实例带你揭秘!

    统计学的卡方检验方法是什么呢?用几个生活实例带你揭秘!作者|文文酱的数据课堂来源|知乎专栏https://zhuanlan.zhihu.com/p/69888032卡方检验,统计学的方法,现在机器学习看变量的时候也会用到。很多不知道…

    2022年5月13日
    40
  • 利用JDK发布webService实例「建议收藏」

    利用JDK发布webService实例「建议收藏」一、webService的发布1、新建一个webProject2、修改jdk为1.6及以上—-3、编写方法—- packagecom.test.webService;importjavax.jws.WebService;importjavax.xml.ws.Endpoint;@WebServicepublicclass

    2022年7月21日
    18
  • 网页设计与制作毕业论文(解析ip数据包课程设计)

    PAGE单位代码学号分类号毕业设计(论文)基于HTML5的P2P流媒体传输技术的设计与实现院(系)名称专业名称计算机科学与技术学生姓名指导教师2014年6月北京航空航天大学毕业设计(论文)第PAGE\*ROMANI页基于HTML5的P2P流媒体传输技术的设计与实现摘要P2P流媒体传输技术是一项基于对等网络的大规模流媒体实时直播技术。P2P流媒体传输技术使…

    2022年4月15日
    57
  • 集群管理软件介绍_集群管理是什么意思

    集群管理软件介绍_集群管理是什么意思转载。From https://blog.csdn.net/swingwang/article/details/77971905集群就是通过软件将一组服务器作为一个整体向客户提供资源。这些单个的服务器就是集群的节点。当对外提供资源的节点故障后,集群中其余的节点能够将资源接管起来,继续对客户提供资源。集群技术的核心就是资源访问控制。由于集群中所有节点都可以访问集群对外共享的资源,当多个节点同时操作…

    2022年10月15日
    3

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号