swagger 注释

①类名上用@Api(description = "能力相关API") 注解

@RestController
@RequestMapping("/api")
@Api(description = "能力相关API")
public class CompetencyClientResource 

②方法上用@ApiOperation("能力删除")注解(@ApiParam 是对competencyId的注释)

@ApiOperation("能力删除")
@PostMapping("/competency/delete/{competencyId}")
@Timed
public ResponseEntity<String> deleteCompetency(@ApiParam("能力ID") @PathVariable Long competencyId)

③在model上的注解用 @ApiModel

@ApiModel("检索条件DTO")
public class QuerySkillDTO implements Serializable {

    @ApiModelProperty("技能名称或编码")
    private String nameOrCode;

    @ApiModelProperty("技能类型")
    private String category;

    @ApiModelProperty("页数")
    private int page = 0;

    @ApiModelProperty("件数")
    private int size = 10;

swagger展示视图就不截图了,几个注解简单的用法,稍微记载一下,便于以后再用。


  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值