本文详细介绍了Api、ApiOperation、ApiImplicitParams等注解在Java API开发中的作用，展示了如何使用@ApiResponses处理错误响应，并通过@ApiModel和ApiModelProperty阐述了模型定义。重点讲解了如何构建完整、易懂的API接口文档。
- @Api : 用在类上，说明该类的主要作用。
- @ApiOperation：用在方法上，给API增加方法说明。
- @ApiImplicitParams : 用在方法上，包含一组参数说明。
- @ApiImplicitParam：用来注解来给方法入参增加说明。
-
@ApiResponses：用于表示一组响应。
-
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
-
code：数字，例如400
-
message：信息，例如"请求参数没填好"
-
response：抛出异常的类
-
-
-
@ApiModel：用在返回对象类上，描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
-
@ApiModelProperty：描述一个model的属性
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
