Springdoc如何将未匹配自定义分组的接口自动归集到默认分组
Springdoc 默认分组问题解答
Springdoc 没有提供开箱即用的自动归集能力,无法在自定义GroupedOpenApiBean后,自动把未被任何分组匹配的接口归集到默认分组。
底层默认逻辑
项目中不存在任何自定义GroupedOpenApiBean时,Springdoc会自动生成内置默认分组,访问路径为/v3/api-docs,默认扫描加载所有接口。只要手动注册了至少一个GroupedOpenApiBean,这个内置全量默认分组就会直接失效,不会自动创建。
落地实现
要让/pet这类未匹配自定义分组规则的接口归入默认分组,必须额外定义默认分组对应的GroupedOpenApiBean,不需要写复杂的逐路径排除规则,共有两种可选方案:
- 允许接口同时归属多个分组(最简方案)
直接定义匹配全路径的默认分组即可:
配置后访问@Bean public GroupedOpenApi defaultGroup() { return GroupedOpenApi.builder() .group("default") .pathsToMatch("/**") .build(); }/v3/api-docs/default即可获取包含/pet在内的全量接口文档,注意此时/user接口会同时存在于user分组和default分组中。 - 要求接口仅归属唯一分组(严格匹配)
这类场景需要给默认分组配置排除规则,不需要手动枚举所有其他分组的匹配路径,可统一提取所有自定义分组的匹配规则作为默认分组的排除条件,避免硬编码维护。目前Springdoc没有内置自动计算未匹配接口集合的逻辑,这类场景下排除规则是必须的,不存在零配置实现方式。
内容的提问来源于stack exchange,提问作者Shabin Shajahan
相关产品推荐
相关产品推荐

