2025年swagger2.0 出参map(swagger pathmapping)

swagger2.0 出参map(swagger pathmapping)开启 Swagger 实体类 Docket 实现了 Documentatio 接口 Documentatio 接口是文档插件 Swagger 通过文档插件来实现输出的 Documentatio 构造函数需要传入 Documentatio 我们一般设置为 Documentatio SWAGGER 2 SimplePlugin

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



 

讯享网

开启Swagger

讯享网

实体类

 
讯享网

Docket实现了DocumentationPlugin接口。DocumentationPlugin接口是文档插件,Swagger通过文档插件来实现输出的。

 
讯享网

DocumentationType 构造函数需要传入DocumentationType,我们一般设置为DocumentationType.SWAGGER_2。

 

SimplePluginMetadata

讯享网
 

ApiInfo配置文档信息

讯享网

1)Contact

 

2)ApiInfoBuilder

build()方法构建ApiInfo实体类。

讯享网

未配置ApiInfo效果:

image.png
讯享网

配置ApiInfo效果:

image.png

  • enable(false) 关闭Swagger
 

image.png

  • groupName()配置一个分组

image.png

设置请求头信息

讯享网

生成参数:

 

效果

image.png

image.png

设置需要登录认证的路径

讯享网

参数创建

 

1)SecurityContext

一个类,用于表示应用于每个api操作的默认授权集

要自定义应用授权列表的请求映射,请指定自定义includePatterns或requestMethods

讯享网

使用:

 

1) .select()

讯享网

2) .apis()

RequestHandlerSelectors配置要扫描接口的方式

basePackage:指定要扫描的包=>RequestHandlerSelectors.basePackage(“com.kuang.swagger.controller”) any():扫描全部 none():全部不扫描

withClassAnnotation:扫描类上的注解=>RequestHandlerSelectors.withClassAnnotation(RestController.class)

withMethodAnnotation:扫描方法上的注解=>RequestHandlerSelectors.withMethodAnnotation(GetMapping.class)

 

3) .paths()

Path:过滤路径 ant:指定路径 any:过滤全部 none:全部不过滤 regex:按照正则表达式来过滤

讯享网

小讯
上一篇 2025-06-07 20:07
下一篇 2025-05-09 23:37

相关推荐

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