API 文档构建工具 - Swagger2简单应用

本文介绍了如何使用 Swagger2 构建 API 文档,详细展示了@Api、@ApiOperation、@ApiImplicitParam等注解的用法,用于描述接口、方法、参数及其响应,帮助开发者更好地理解和使用API。
摘要由CSDN通过智能技术生成

return new ApiInfoBuilder()

.title( “用户管理接口API文档” )

.version( “1.0” )

.build();

}

}

@Api 作用到类上面 说明类的作用

@Api(tags=“APP用户注册Controller”)

@ApiModel

用于响应类上,表示一个返回响应数据的信息

(这种一般用在post创建的时候,使用@RequestBody这样的场景,

请求参数无法使用@ApiImplicitParam注解进行描述的时候)

@ApiModelProperty:用在属性上,描述响应类的属性

@ApiOperation

@ApiOperation:“用在请求的方法上,说明方法的作用”

value=“说明方法的作用”

notes="方法的备注说明

@ApiOperation(value=“用户注册”,notes=“手机号、密码都是必填项,年龄是选填项,但必须是数字”)

@ApiImplicitParams:用在请求的方法上,包含一组参数说明

@ApiImplicitParam:用在 @ApiImplicitParams 注解中,指定一个请求参数的配置信息

name:参数名

value:参数的汉字说明、解释

required:参数是否必须传

paramTypeÿ

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值