Как исключить пути при использовании GroupedOpenAPI с SpringDoc - PullRequest
0 голосов
/ 05 февраля 2020

Недавно я отключил SpringFox для SpringDo c.

Ранее мне удавалось исключить пути, которые будут использоваться для интерфейса Swagger, примерно так:

new Docket(DocumentationType.SWAGGER_2).paths(Predicates.not(PathSelectors.regex("/path1/.*|/path2/.*|/path4/.*")))

В случае выше, Swagger UI отображал бы для path3 и path5.

Используя GroupedOpenAPI при использовании SpringDo c, я видел только способ явно указать, какие пути должны быть разрешены, например

GroupedOpenApi.builder()
            .pathsToMatch("/path3/**", "/path5/**")

Я бы предпочел иметь более общий c способ, посредством которого я могу указать, какие пути НЕ разрешать, поэтому, если я добавлю дополнительные пути, они будут разрешены по умолчанию. Что-то вроде:

GroupedOpenApi.builder()
            .pathsToMatch("!/path1/**", "!/path2/**", "!/path4/**")

Не уверен, поддерживается ли какая-либо функция, подобная этой. Любая помощь будет оценена. Спасибо.

1 Ответ

2 голосов
/ 25 февраля 2020

Вы можете использовать следующее свойство, чтобы исключить пути (протестировано с v1.2.32)

springdoc.paths-to-exclude= /test

Или:

GroupedOpenApi.builder()
            .pathsToExclude("!/path1/**", "!/path2/**", "!/path4/**")
...