举例：@ApiOperation(value=“修改密码”,notes=“方法的备注说明，如果有可以写在这里”)@PostMapping('/changepass')publicAjaxResultchangePassword(@AutosetParamSessionInfosessionInfo,@RequestBody@ValidPasswordModelpasswordMode{//TODO}
@ApiImplicitParams、@ApiImplicitParam：方法参数的说明
@ApiModel：用于JavaBean上面，表示一个JavaBean
@ApiModel：用于JavaBean的类上面，表示此JavaBean整体的信息
@ApiImplicitParams：用在请求的方法上，包含一组参数说明@ApiImplicitParam：对单个参数的说明name：参数名value：参数的汉字说明、解释required：参数是否必须传paramType：参数放在哪个地方·header-->请求参数的获取：@RequestHeader·query-->请求参数的获取：@RequestParam·path–>请求参数的获取：@PathVariable·body–>@RequestBodyUseruser·formdataType：参数类型，默认String，其它值dataType=“int”defaultValue：参数的默认值
举例：@ApiOperation(value=“用户登录”,notes=“随边说点啥”)@ApiImplicitParams({@ApiImplicitParam(name=“mobile”,value=“手机号”,required=true,paramType=“form”),@ApiImplicitParam(name=“password”,value=“密码”,required=true,paramType=“form”),@ApiImplicitParam(name=“age”,value=“年龄”,required=true,paramType=“form”,dataType=“Integer”)})@PostMapping('/login')publicAjaxResultlogin(@RequestParamStringmobile,@RequestParamStringpassword,@RequestParamIntegerag{//TODOreturnAjaxResult.OK();}
@ApiResponses：方法返回对象的说明@ApiResponse：每个参数的说明code：数字，例如400message：信息，例如'请求参数没填好'response：抛出异常的类
@ApiModel和@ApiModelProperty举例：@ApiModel(“修改密码所需参数封装类”)publicclassPasswordModel{@ApiModelProperty(“账户Id”)privateStringaccountId;//TODO}
举例：@Api(tags=“账户相关模块”)@RestController@RequestMapping('/api/account')publicclassAccountController{//TODO}
@Api：放在请求的类上，与@Controller并列，说明类的作用，如用户模块，订单类等。tags=“说明该类的作用”value=“该参数没什么意义，所以不需要配置”
举例：@ApiOperation(value=“修改密码”,notes=“方法的备注说明，如果有可以写在这里”)@ApiResponses({@ApiResponse(code=400,message=“请求参数没填好”),@ApiResponse(code=404,message=“请求路径找不到”)})@PostMapping('/changepass')publicAjaxResultchangePassword(@AutosetParamSessionInfosessionInfo,@RequestBody@ValidPasswordModelpasswordMode{//TODO}
单个参数举例@ApiOperation(“根据部门Id删除”)@ApiImplicitParam(name=“depId”,value=“部门id”,required=true,paramType=“query”)@GetMapping('/delete')publicAjaxResultdelete(StringdepI{//TODO}
@Api：请求类的说明
@ApiOperation：“用在请求的方法上，说明方法的作用”value=“说明方法的作用”notes=“方法的备注说明”
@ApiOperation：方法的说明
然后在项目中全局搜索：将swagger-uhtml修改成dohtml。我的一共是修改了两个地方分别是：
@ApiResponses、@ApiResponse：方法返回值的说明
文章为作者独立观点，不代表股票交易接口观点
相关文章
股民评论