Swagger中的一些常用注解(上)

简介: Swagger中的一些常用注解(上)

写在前面


今天我们来学习Swagger中的一些常用注解,虽然我们可能常用的注解就那么几个,但是如果要像外部展示更多信息的话,还是非常 有必要学习的。


Swagger常用的注解如何使用?


Swagger是生成api文档的一个组件,本篇文章不是讲如何集成,而是讲述一下其中的一些注解的使用。

来看一下吧。


@Api注解


此注解,是用于修饰类名的,其中可以传入value参数,和tags参数等等。

value参数是用于体现此类接口的大标题。

而tags参数是用来展示此类接口的一些关键说明。


@ApiModel注解


此注解,是用于修饰数据模型,同样也是修饰类名的。

一般都是修饰数据模型相关的类,其中也可以传入value,用于数据模型的命名。

除了value外,还有description参数,从名称来看就知道是描述的作用。

在数据模型中其实也可以不传入value,但是如果一个项目内有两个都没有传入,swagger中就会只有一个数据模型,因为没有vlaue名称,没办法起到唯一标识的作用;就只能覆盖了。


@ApiModelProperty注解


此注解,和APIModel是搭配使用的,如果数据模型被ApiModel修饰了,那么其中的变量也要输出到swagger文档中呀。

所以就用得上ApiModelProperty注解了,来修饰变量,并且可以指定value,来对变量进行一个说明。

这个注解是用的最多的了,其中还有name,也就是重写该变量的名称。

dataType属性,从名称来看就知道是数据类型,指定的也是该变量的数据类型。

还有required属性,标识该字段是否必填。

hidden属性,就是隐藏了,这个不用多说。


总结


今天我们来学习了swagger中的一些注解,如果你使用过,其实也没什么,根据自己的文档展示需要妥善使用注解即可。


相关文章
|
6月前
|
Java API
Swagger 常用注解使用详解
Swagger 常用注解使用详解
111 2
|
2月前
|
API
Swagger2 常用注解介绍
Swagger2 常用注解介绍
|
4月前
|
JSON 数据格式
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
|
6月前
|
Dubbo Java 测试技术
提升API文档品质:Swagger annotations (注解)使用教程
Swagger 提供的注解集是其框架中定义 API 规范和文档的重要工具。这些注解在代码里标注重要部分,为 Swagger 的解析工作铺路,进而生成详尽的 API 文档。开发者编写的注释能够被转换成直观的文档,并展现API端点、参数和响应等信息。这不仅提升了开发人员对 API 运作的理解与沟通,也使得测试和集成过程更加顺畅。
|
6月前
|
搜索推荐
Swagger中的一些常用注解(下)
Swagger中的一些常用注解(下)
70 0
|
6月前
|
JSON 前端开发 Java
历经14天自定义3个注解解决项目的3个Swagger难题
历经14天自定义3个注解解决项目的3个Swagger难题
161 0
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
97 0
|
API
Swagger核心注解总结(四)
Swagger核心注解总结(四)
223 2
|
API
swagger文档使用常用注解
swagger文档使用常用注解
460 0
|
JSON 数据格式
swagger参数注解,后台使用@RequestBody注解的实体类,但只需要传实体类中的一个属性
这样写的结果会是下面这个样子,导致出现两个参数,一个实体类传参类型是json格式,一个是注解中写的属性。