温馨提示:
springBoot 版本 3.0+
knife4j 版本 4.1.0
添加依赖:knife4j包含了swagger,openapi3中的依赖,所以加这一个就行。
yml文件中配置:
#springdoc相关配置
springdoc:
swagger-ui:
path: /swagger-ui.html
tags-sorter: alpha
operations-sorter: alpha
api-docs:
path: /v3/api-docs
group-configs:
- group: 'hyc'
paths-to-match: '/**'
packages-to-scan: com.hyc #改成你自己的包名,一般到启动类的包名
#knife4j相关配置 可以不用改
knife4j:
enable: true
setting:
language: zh_cn
swagger-model-name: 实体类
然后,就可以启动测试输入地址http://ip:port/doc.html
注解的基本使用可以看下这里:swagger3注解和swagger2的区别
这里主要提下请求参数为文件的时候怎么写
@Parameter(name = "image", description = "图片文件", required = true,schema =@Schema(type = "file"))
在@Parameter参数注解里面加
schema = @Schema(type = "string", format = "binary")
注意:如果实体类没有在页面显示如下:
这是因为你这个实体类没有在controller层使用,没有使用,就不会在这显示的。
相关文章
发表评论