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

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

写在前面


昨天我们说了swagger的一部分注解,了解到了如何注释controller类,还有如何注释视图模型、数据模型等等的注解,今天我们接着来看其他的一些注解。一起来看看吧。


Swagger常用的注解如何使用?


Swagger是什么我就不说了,大家可以去网上查一下即可。

现在来看一下如何Swagger的其他注解吧。


ApiIgnore注解


该注解,从名称来看,能分辨出这个注解是一种忽略功能,对的,就是忽略功能,如果你的Controller类不愿意向外暴露,那么就在类中引入这个注解。

这样的话,swagger就无法扫描出这个类的接口了。


ApiImplicitParams注解


该注解是为了给参数标明信息的,比如我们现在有一个查询接口,但是不是使用的Post请求,使用的是Get请求,后端只能通过request来获取。

这样的话,swagger就算再强大也没办法扫描出来参数是什么,这个时候就需要这个注解了,用来个性化展示参数值。

具体如何使用需要下面的注解一起搭配使用。


ApiImplicitParam注解


该注解需要上面的注解搭配使用,先看一个例子再说。

@ApiImplicitParams({
        @ApiImplicitParam(paramType = "query", name = "username", value = "用户名称", dataType = "String", dataTypeClass = String.class),
        @ApiImplicitParam(paramType = "query", name = "age", value = "年龄", dataType = "int", dataTypeClass = Integer.class),
})

使用ApiImplicitParams注解声明出一个集合,然后内部元素可以有多个ApiImplicitParam注解。

ApiImplicitParam注解还可以有paramType、name、value、dataType、dataTypeClass等参数。

paramType:标识此参数用于的位置,比如query、header等等

name:标识参数字段。

value:参数的描述信息就在这里写。

dataType:参数的数据类型。

dataTypeClass:参数的数据类型所使用的Class类,如果不加这个参数,启动会有一堆警告。

大概就是这个样子了,你学会了吗?


总结

今天我们又学习了swagger中的一些注解,swagger也就这几个注解,记住并不难,重要的是要懂得灵活运用才好,希望能帮到大家。


相关文章
|
6月前
|
Java API
Swagger 常用注解使用详解
Swagger 常用注解使用详解
102 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月前
|
API
Swagger中的一些常用注解(上)
Swagger中的一些常用注解(上)
47 0
|
6月前
|
JSON 前端开发 Java
历经14天自定义3个注解解决项目的3个Swagger难题
历经14天自定义3个注解解决项目的3个Swagger难题
157 0
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
95 0
|
API
Swagger核心注解总结(四)
Swagger核心注解总结(四)
212 2
|
API
swagger文档使用常用注解
swagger文档使用常用注解
455 0
|
JSON 数据格式
swagger参数注解,后台使用@RequestBody注解的实体类,但只需要传实体类中的一个属性
这样写的结果会是下面这个样子,导致出现两个参数,一个实体类传参类型是json格式,一个是注解中写的属性。