swagger的基本使用

Controller类上注解

@Api(tags = "AberrantController",description = "设置-系统配置-异常设置")

    用于在页面显示该控制器的控制器名字和中文解释

方法上注解

@ApiOperation(value = "异常设置-[修改A0001]")

   说明该方法的定义义

@ApiResponses({@ApiResponse(code=500,message="INTERNAL_SERVER_ERROR")})

   该方法返回数据各个状态码表示的含义

方法内参数的注解

@ApiParam(value = "保存异常设置", required = true)

 说明该参数的含义,及是否必须填写效验

dto的属性注解

@ApiModelProperty(value = "排序序号",required = true)

该属性的中文含义及是否必须

 

你可能感兴趣的:(工具)