注解篇-Swagger常用注解详解 swagger3注解

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。

swagger的接口文档有两种风格，分别为水平列表和树形分类。

下面将介绍swagger常用的几个注解：

@Api 标识一个java类型是文档类，用controller类的类名上

@ApiModel 表示一个实体类/模型文档，用在类名上；

@ApiModelProperty 作用在属性上，添加属性描述；

@ApiOperation 作用在接口类的方法上，控制方法的相关描述；

@ApiImplicitParam 作用在接口方法上，描述单个参数信息

@ApiImplicitParamS 作用在接口方法上，@ApiImplicitParam数组

@ApiParam 作用在接口方法上，描述单个参数信息，基本与@ApiImplicitParam一样

PS：若觉得我的文章还不错，记得点赞评论加关注哦！！！

Tags：apiimplicitparam注解用法