我在看公司之前的文檔,發(fā)現(xiàn)了@schema注解,不太了解,所以查詢了一些資料,把我的見解記錄下:
開始的時候,沒查到太多信息,后來查到了,原來就是用過的@APImodel注解,一個是swagger2常用的注解,一個是swagger3常用的注解。
swagger2常用的5個注解:
最常用的5個注解
@Api:修飾整個類,描述Controller的作用
@ApiOperation:描述一個類的一個方法,或者說一個接口
@ApiParam:單個參數(shù)描述
@ApiModel:用對象來接收參數(shù)
@ApiProperty:用對象接收參數(shù)時,描述對象的一個字段
其它若干
@ApiResponse:HTTP響應(yīng)其中1個描述
@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只需要一個依賴即可
<!-- 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")
之后我問了GPT4:
?
?今天又學(xué)到一個新注解@schema,加油文章來源:http://www.zghlxwxcb.cn/news/detail-471075.html
?文章來源地址http://www.zghlxwxcb.cn/news/detail-471075.html
到了這里,關(guān)于@Schema和@ApiModel等注解的聯(lián)系的文章就介紹完了。如果您還想了解更多內(nèi)容,請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!