Java?@Schema和@ApiModel等注解的聯(lián)系淺析
引言
我在看公司之前的文檔，發(fā)現(xiàn)了@schema注解，不太了解，所以查詢了一些資料，把我的見(jiàn)解記錄下：
開(kāi)始的時(shí)候，沒(méi)查到太多信息，后來(lái)查到了，原來(lái)就是用過(guò)的@APImodel注解，一個(gè)是swagger2常用的注解，一個(gè)是swagger3常用的注解。
swagger2常用的5個(gè)注解：
最常用的5個(gè)注解 @Api：修飾整個(gè)類(lèi)，描述Controller的作用 @ApiOperation：描述一個(gè)類(lèi)的一個(gè)方法，或者說(shuō)一個(gè)接口 @ApiParam：?jiǎn)蝹€(gè)參數(shù)描述 @ApiModel：用對(duì)象來(lái)接收參數(shù) @ApiProperty：用對(duì)象接收參數(shù)時(shí)，描述對(duì)象的一個(gè)字段 其它若干 @ApiResponse：HTTP響應(yīng)其中1個(gè)描述 @ApiResponses：HTTP響應(yīng)整體描述 @ApiClass @ApiError @ApiErrors @ApiParamImplicit @ApiParamsImplicit
用 swagger 3 注釋替換 swagger 2 注釋
（它已經(jīng)包含在springdoc-openapi-ui依賴項(xiàng)中）。swagger 3 注釋的包是io.swagger.v3.oas.annotations
依賴項(xiàng)：
swagger3只需要一個(gè)依賴即可
<!-- 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的變化規(guī)則：
@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")
之后我問(wèn)了GPT4：
今天又學(xué)到一個(gè)新注解@schema,加油
總結(jié)
到此這篇關(guān)于Java @Schema和@ApiModel等注解聯(lián)系的文章就介紹到這了,更多相關(guān)@Schema和@ApiModel注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
JavaScript基本語(yǔ)法學(xué)習(xí)教程
javascript語(yǔ)言是網(wǎng)頁(yè)中廣泛使用的一種腳本語(yǔ)言，通過(guò)本文給大家介紹javascript基本語(yǔ)法，需要的朋友可以參考下本文2016-01-01
小程序?qū)崿F(xiàn)授權(quán)登陸的解決方案
這篇文章主要介紹了小程序?qū)崿F(xiàn)授權(quán)登陸的解決方案，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-12-12
ES6新增了let命令,用來(lái)聲明變量,它的用法類(lèi)似于var,但是所聲明的變量,只在let命令所在的代碼塊內(nèi)有效,下面這篇文章主要給大家介紹了關(guān)于JS中l(wèi)et的基本用法,需要的朋友可以參考下2023-01-01
這篇文章主要介紹了比例尺、縮略圖、平移縮放之百度地圖添加控件方法,大家都知道百度地圖API中提供了豐富的控件，您還可以通過(guò)Control類(lèi)來(lái)實(shí)現(xiàn)自定義控件，需要的朋友可以參考下2015-08-08
JavaScript中.min.js和.js文件的區(qū)別講解
今天小編就為大家分享一篇關(guān)于JavaScript中.min.js和.js文件的區(qū)別講解，小編覺(jué)得內(nèi)容挺不錯(cuò)的，現(xiàn)在分享給大家，具有很好的參考價(jià)值，需要的朋友一起跟隨小編來(lái)看看吧2019-02-02
微信小程序?qū)崿F(xiàn)多行文字滾動(dòng)效果
這篇文章主要介紹了微信小程序?qū)崿F(xiàn)多行文字滾動(dòng)效果，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-03-03
淺談javascript中l(wèi)odash與lodash-es的區(qū)別
本文主要介紹了javascript中l(wèi)odash與lodash-es的區(qū)別,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-10-10
這篇文章主要為大家詳細(xì)介紹了JavaScript之cookie技術(shù),運(yùn)用JS設(shè)置cookie、讀取cookie、刪除cookie ,需要的朋友可以參考下2016-11-11
2009-04-04
基于aotu.js實(shí)現(xiàn)微信自動(dòng)添加通訊錄中的聯(lián)系人功能
這篇文章主要介紹了利用aotu.js實(shí)現(xiàn)微信自動(dòng)添加通訊錄中的聯(lián)系人,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-05-05