0
点赞
收藏
分享

微信扫一扫

【Java】java | swagger用法


一、说明

        1、备份下swagger用法

二、注解使用

1、用于Controller

1)注解

@Api(tags = "登录")

说明: 归类,即一级菜单

示例:

【Java】java | swagger用法_请求参数


~~

2、用于请求

1)注解

@ApiOperation("账号密码登录")

说明:具体接口

3、用于请求参数

1)注解
@ApiImplicitParams({
@ApiImplicitParam(name = "username", value = "用户名,需RSA公钥加密",type = "String", required = true),
@ApiImplicitParam(name = "password", value = "密码,需RSA公钥加密", type = "String", required = true),
})
说明: 此注解,逐个描述;如果没有入参,则不需要注解

 4、忽略请求入参在文档显示

1)注解

@ApiIgnore

示例:

【Java】java | swagger用法_请求参数_02

说明:如果不忽略,文档就会限制LoginBody中的字段以及@ApiImplicitParam

说明:LoginBody包括了username,password,code,uuid,但这个接口只用到username,password

~~

5、用于结果响应

1)注解

@ApiResponses({
@ApiResponse(code = 200, message = "个人资料", response = UserInfoVo.class)
})

说明1: 主动指明返回的参数;为什么要这么做?因为外层是extendHashMap实现的,所以外层渲染报错,直接渲染业务参数

说明2:UserInfoVo也需要用@ApiModel与@ApiModelProperty

说明3:如果直接返回实体;不加@ApiResponses即可

示例图:

【Java】java | swagger用法_java_03

 

【Java】java | swagger用法_开发语言_04

 

~~

 

举报

相关推荐

0 条评论