swagger annotation

一、基于类的注解
@Api(tags={"用户操作接口"})
1.tags:对controller的描述。数组类型,可填写多个值,即生成多个相同的列表,只是描述有区别;
二、基于方法的注解
@ApiOperation(value="根据订单信息获取下户专员信息", notes="根据订单的Id获取下户专员的详细信息", httpMethod = "POST")
1.value:对action的简述;
2.notes:对action的详细描述;
3.httpMethod:action的调用方式(可填写 "GET"/"POST"/"DELETE"/"PUT");
注:建议必填,如果不填写,会生成全部调用方式的action条目。
@ApiParam(name = "username", value = "下户专员姓名", required = true)
1.name:参数名字;
注:建议校对,如果输入错误,不会自动判重。
2.value:参数的描述;
3.required:是否是必传参数。布尔值类型。
注:如果填写“true”,在页面调用api会提示必填。
注意:此注解后要跟一个 @RequestParam() 注解,不然在swagger ui中参数类型不会被定义为 query ,测试调用的时候,会拿不到传参值。
@ApiIgnore()
注:action加此注解,就不会显示在swagger的页面上。
三、基于实体的注解(如果接口返回或者传参是一个实体,那么下面的两个注解会有用)
@ApiModel(value="银行信息",description="记录银行详细信息")
@ApiModelProperty(value="卡号",name="cardNo",required=true)
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值