码迷,mamicode.com
首页 > 其他好文 > 详细

(傲娇的白狐)Swagger给实体类 接口加注释

时间:2020-07-26 19:34:20      阅读:130      评论:0      收藏:0      [点我收藏+]

标签:ping   文档   pass   实体   ret   prope   agg   return   app   

 

----- swagger 给一些比较难以理解的属性或者接口 加上注释

---- 接口文档实时更新

-===============接口============== 加注释


/ 只要扫描的接口中存在实体类,它就会被扫描到swagger中。
@ApiOperation("postuserinfo方法")
@PostMapping("/userinfo")
public Userinfo get(){

return new Userinfo();
}

@ApiOperation("post 方法")
@PostMapping("/postuset")
public String postud(@ApiParam("userinfo") String userinfo){

return "欢迎post "+userinfo;
}

@ApiOperation("get 方法")
@GetMapping("/getuset")
public String getud(@ApiParam("userinfo") String userinfo){

return "欢迎get "+userinfo;
}


================ 实体类


@ApiModel("用户实体类")
public class Userinfo {
@ApiModelProperty("用户ID")
private int id;

@ApiModelProperty("用户名")
private String name;

@ApiModelProperty("用户密码")
private String password;

(傲娇的白狐)Swagger给实体类 接口加注释

标签:ping   文档   pass   实体   ret   prope   agg   return   app   

原文地址:https://www.cnblogs.com/aojiaodebaihuBlog/p/13381266.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!