Java @Schema和@ApiModel等注解的联系浅析
引言
我在看公司之前的文档，发现了@schema注解，不太了解，所以查询了一些资料，把我的见解记录下：
开始的时候，没查到太多信息，后来查到了，原来就是用过的@APImodel注解，一个是swagger2常用的注解，一个是swagger3常用的注解。
swagger2常用的5个注解：
最常用的5个注解 @Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接口 @ApiParam：单个参数描述 @ApiModel：用对象来接收参数 @ApiProperty：用对象接收参数时，描述对象的一个字段 其它若干 @ApiResponse：HTTP响应其中1个描述 @ApiResponses：HTTP响应整体描述 @ApiClass @ApiError @ApiErrors @ApiParamImplicit @ApiParamsImplicit
用 swagger 3 注释替换 swagger 2 注释
（它已经包含在springdoc-openapi-ui依赖项中）。swagger 3 注释的包是io.swagger.v3.oas.annotations
依赖项：
swagger3只需要一个依赖即可
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>swagger2到swagger3的变化规则：
@Api → @Tag
@ApiIgnore→@Parameter(hidden = true)或@Operation(hidden = true)或@Hidden
@ApiImplicitParam → @Parameter
@ApiImplicitParams → @Parameters
@ApiModel → @Schema
@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)
@ApiModelProperty → @Schema
@ApiOperation(value = "foo", notes = "bar") → @Operation(summary = "foo", description = "bar")
@ApiParam → @Parameter
@ApiResponse(code = 404, message = "foo") → @ApiResponse(responseCode = "404", description = "foo")
之后我问了GPT4：
今天又学到一个新注解@schema,加油
总结
到此这篇关于Java @Schema和@ApiModel等注解联系的文章就介绍到这了,更多相关@Schema和@ApiModel注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
本文记录一下在使用 flv.js 播放监控视频时踩过的各种各样的坑,虽然官网给的 Getting Started 只有短短几行代码,跑一个能播视频的 demo 很容易,但是播放时各种各样的异常会搞到你怀疑人生,下面我将自己踩过的坑,以及踩坑过程中补充的相关知识,详细总结一下2023-10-10
如果您希望一遍又一遍地运行相同的代码，并且每次的值都不同，那么使用循环是很方便的,javascript中for循环也是非常常用的,下面这篇文章主要介绍了Javascript中for循环的几种写法,需要的朋友可以参考借鉴，一起来看看吧。2017-01-01
深入理解webpack process.env.NODE_ENV配置
这篇文章主要介绍了深入理解webpack process.env.NODE_ENV配置，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-02-02
兼容Firefox的Javascript XSLT 处理XML文件
这篇文章主要介绍了兼容Firefox的Javascript XSLT 处理XML文件,需要的朋友可以参考下2014-12-12
网页进度条能够更好的反应当前网页的加载进度情况，loading进度条可用动画的形式从开始0%到100%完成网页加载这一过程。代码简单易懂，效果非常好，需要的一起学习学习吧2015-09-09
深入理解JavaScript系列(10) JavaScript核心（晋级高手必读篇）
本篇是ECMA-262-3 in detail系列的一个概述（本人后续会翻译整理这些文章到本系列（第11-19章）。每个章节都有一个更详细的内容链接，你可以继续读一下每个章节对应的详细内容链接进行更深入的了解2012-01-01
在做项目的时候，经常遇到发短信验证码的问题，这时候需要用户点完发送验证码按钮后，一段时间内不能重复点击，毕竟验证码都是收费的嘛，谁都不想浪费，那么如何实现这种功能呢？下面来分享一下。2014-06-06
Javascript操纵Cookie实现购物车程序...2006-11-11
这篇文章通过图文详细的给大家介绍了关于Javascript中的上下文与作用域背后的机制，主要涉及到执行上下文（execution context）、作用域链（scope chain）、闭包（closure）、this等概念。需要的朋友可以参考借鉴，下面来一起看看吧。2017-02-02
这篇文章主要为大家详细介绍了微信小程序云开发之使用云存储，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-05-05
最新评论