(傲嬌的白狐)Swagger給實體類 接口加注釋


 

----- 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;


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM