2025年swagger的配置(swagger configuration)

swagger的配置(swagger configuration)PS 引入依赖的时候要注意 swagger 的版本要和 Springboot 的版本对应 不然会出现空指针异常 相关版本 本人使用 springboot 2 6 6 swagger3 0 0 版本一 Spring Boot 版本 Swagger 版本 2 5 6 2 9

大家好,我是讯享网,很高兴认识大家。



 

讯享网

PS:引入依赖的时候要注意swagger的版本要和Springboot的版本对应,不然会出现空指针异常!

相关版本:(本人使用springboot:2.6.6+swagger3.0.0)

版本一:

Spring Boot版本Swagger 版本2.5.62.9.2

版本二:

Spring Boot版本Swagger 版本2.6.53.0.0

 添加配置:

讯享网

创建配置类:

 

@Api(tags="")
用在请求的类上,表示对类的说明
tags"说明该类的作用,可以在UI界面上看到的注解"

@ApiOperation(value="")
用在请求的方法上,说明方法的用途、作用
value=“说明方法的用途、作用”


讯享网

@ApiImplicitParam
@ApiImplicitParam:指定一个请求参数的各个方面
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
header –> 请求头的获取:@·RequestHeader
query –> 请求参数的获取:@RequestParam
path(用于restful接口)–> 请求路径变量的获取:

@PathVariable
body(不常用)
form(不常用)
dataType:参数类型,默认String,其它值dataType=“Integer”
defaultValue:参数的默认值

@ApiResponse
用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类

@ApiModel
主要有两种用途:
用于响应类上,表示一个返回响应数据的信息
入参实体:使用@RequestBody这样的场景, 请求参数无法使用@ApiImplicitParam注解进行描述的时候

 

  

小讯
上一篇 2025-04-25 22:54
下一篇 2025-05-28 20:57

相关推荐

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/206907.html