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)文章
使用js判斷數(shù)組中是否包含某一元素(類(lèi)似于php中的in_array())
這篇文章主要是對(duì)使用js判斷數(shù)組中是否包含某一元素(類(lèi)似于php中的in_array())需要的朋友可以過(guò)來(lái)參考下，希望對(duì)大家有所幫助2013-12-12
JavaScript函數(shù)執(zhí)行、作用域鏈以及內(nèi)存管理詳解
這篇文章主要介紹了JavaScript函數(shù)執(zhí)行、作用域鏈以及內(nèi)存管理的知識(shí)，文章內(nèi)容非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-01-01
基于JavaScript實(shí)現(xiàn)高德地圖和百度地圖提取行政區(qū)邊界經(jīng)緯度坐標(biāo)
本文給大家介紹javascript實(shí)現(xiàn)高德地圖和百度地圖提取行政區(qū)邊界經(jīng)緯度坐標(biāo)的相關(guān)知識(shí)，本文實(shí)用性非常高，代碼簡(jiǎn)單易懂，需要的朋友參考下吧2016-01-01
JavaScript實(shí)現(xiàn)千分位逗號(hào)分隔每3位添加一個(gè)逗號(hào)功能
這篇文章主要給大家介紹了關(guān)于JavaScript實(shí)現(xiàn)千分位逗號(hào)分隔每3位添加一個(gè)逗號(hào)功能的多種方法,文中通過(guò)代碼講解了字符串操作、小數(shù)處理、國(guó)際化支持及特殊值處理,適用于財(cái)務(wù)報(bào)表等場(chǎng)景,需要的朋友可以參考下2025-05-05
Bootstrap 樹(shù)控件使用經(jīng)驗(yàn)分享(圖文解說(shuō))
很多項(xiàng)目中使用樹(shù)來(lái)展示層級(jí)關(guān)系，還有些樹(shù)是為了選中項(xiàng)然后其他地方調(diào)用選中項(xiàng)。今天腳本之家小編給大家?guī)?lái)了Bootstrap 樹(shù)控件使用經(jīng)驗(yàn)分享，需要的朋友參考下吧2017-11-11
前端使用Canvas實(shí)現(xiàn)簽名功能的常見(jiàn)問(wèn)題與解決方法
這篇文章主要為大家詳細(xì)介紹了前端使用Canvas實(shí)現(xiàn)簽名功能的7個(gè)常見(jiàn)問(wèn)題與解決方法,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2025-05-05
利用JavaScript實(shí)現(xiàn)新聞滾動(dòng)效果(實(shí)例代碼)
這篇文章主要是對(duì)利用JavaScript實(shí)現(xiàn)新聞滾動(dòng)效果的兩種方法進(jìn)行了介紹，需要的朋友可以過(guò)來(lái)參考下，希望對(duì)大家有所幫助2013-11-11
這篇文章主要給大家介紹了關(guān)于JavaScript打開(kāi)本地文件夾的4種方法,JavaScript在前端開(kāi)發(fā)中是一種使用非常廣泛的編程語(yǔ)言,常用于實(shí)現(xiàn)網(wǎng)頁(yè)中的交互和動(dòng)態(tài)效果,需要的朋友可以參考下2023-07-07
jQuery實(shí)現(xiàn)文字自動(dòng)橫移
本文詳細(xì)介紹了通過(guò)jquery尺寸相關(guān)函數(shù)實(shí)現(xiàn)文字自動(dòng)橫移的方法。具有一定的參考價(jià)值，下面跟著小編一起來(lái)看下吧2017-01-01
JavaScript實(shí)現(xiàn)限時(shí)秒殺功能
各種電商活動(dòng)都喜換選擇限時(shí)秒殺活動(dòng)形式，這篇文章主要為大家詳細(xì)介紹了JavaScript實(shí)現(xiàn)限時(shí)秒殺功能，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-08-08