当前位置:网站首页 > R语言数据分析 > 正文

swagger的配置(swagger configuration)



 
  

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

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

版本一:

Spring Boot版本 Swagger 版本 2.5.6 2.9.2

版本二:

Spring Boot版本 Swagger 版本 2.6.5 3.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注解进行描述的时候


 

  

到此这篇swagger的配置(swagger configuration)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!

版权声明


相关文章:

  • swagger2配置security(swagger2配置登录)2025-06-16 07:45:08
  • prdlms怎么读(prblms怎么念)2025-06-16 07:45:08
  • pycharm conda 虚拟环境(pycharm使用虚拟环境)2025-06-16 07:45:08
  • lvcreate(lvcreate命令)2025-06-16 07:45:08
  • arguing用法(argue的用法总结)2025-06-16 07:45:08
  • rpro怎么读(rprotect怎么读)2025-06-16 07:45:08
  • yarn命令(yarn命令 介绍linux)2025-06-16 07:45:08
  • vmware密钥(vmware密钥能用几次)2025-06-16 07:45:08
  • prim算法(prim算法生成的最小生成树唯一吗)2025-06-16 07:45:08
  • grid布局和flex布局(grid布局兼容)2025-06-16 07:45:08
  • 全屏图片