若依框架之swagger接口文档

一:
@Api:放在请求的类上,与 @Controller 并列,说明类的作用,如学生类
tags=“说明该类的作用”
例如:
若依框架之swagger接口文档_第1张图片展示效果:

若依框架之swagger接口文档_第2张图片
二:用在方法上
@ApiOperation:“用在请求的方法上,说明方法的作用”
value=“说明方法的作用”
notes=“方法的备注说明”
————————————————
@ApiImplicitParams:用在请求的方法上,包含一组参数说明
@ApiImplicitParam:对单个参数的说明
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)–> 请求参数的获取:@PathVariable
· body(请求体)–> @RequestBody User user
· form(普通表单提交)
dataType:参数类型,默认String,其它值dataType=“int”
defaultValue:参数的默认值
————————————————
@ApiResponses:方法返回对象的说明
@ApiResponse:每个参数的说明
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类

例如:
若依框架之swagger接口文档_第3张图片
效果:
若依框架之swagger接口文档_第4张图片![在这里插入图片描述](https://img-blog.csdnimg.cn/6a82若依框架之swagger接口文档_第5张图片

你可能感兴趣的:(若依框架,spring,cloud,restful,后端,微服务)