@ApiOperation和@ApiParam


@ApiOperation是一個描述接口信息的注解

注解內的常用屬性有

value:接口說明

notes:接口發布說明

httpMethod:接口請求方式(例如:GET、POST)

response:接口返回參數類型(例如:String.class)

@ApiOperation(value="用戶登錄",notes="用戶登錄",httpMethod="GET",response=String.class)
@RequestMapping("/login",method = {RequestMethod.GET}) 
public String login(){ return "success"; }

@ApiParam是一個描述方法參數的注解

注解內的常用屬性有

name:參數名(與請求參數參數名一致)

value:參數說明

required:是否必須

@RequestMapping("/login")
public String login(@ApiParam(name="userId",value="登錄userId",required=true) String userId){
  return "success";  
}

@ApiParam和@ApiImplicitParam類似,都是對方法參數進行標注,但是注解添加的位置不同,@ApiParam添加在方法參數前,@ApiImplicitParam添加在方法前,@ApiImplicitParam擁有dataType和paramType


免責聲明!

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



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