在 Springdoc 中自动生成基于 Swagger 注释的描述

问题描述 投票:0回答:1

基本上我的问题与这个问题相同,但是针对Springdoc(而不是Springfox)。

简而言之,我有一个 Spring-boot 应用程序,并且我正在使用 spring-security @PreAuthorize 注释来保护我的一些 api,目前仅基于

hasAuthority

有没有办法可以根据注解自动修改具体资源的swagger描述?我想这与重写 Springdoc 的默认类行为之一有关(也许

OpenAPICustomiser
?),但我不知道该怎么做。

java swagger swagger-ui springdoc springdoc-openapi-ui
1个回答
5
投票

好吧,我已经用这样的方法解决了-

import org.springdoc.core.customizers.OperationCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.access.prepost.PreAuthorize;
import java.util.Optional;

@Configuration
public class SpringdocPreAuthorize {
    @Bean
    public OperationCustomizer operationCustomizer() {
        return (operation, handlerMethod) -> {
            Optional<PreAuthorize> preAuthorizeAnnotation = Optional.ofNullable(handlerMethod.getMethodAnnotation(PreAuthorize.class));
            StringBuilder sb = new StringBuilder();
            if (preAuthorizeAnnotation.isPresent()) {
                sb.append("This api requires **")
                        .append((preAuthorizeAnnotation.get()).value().replaceAll("hasAuthority|\\(|\\)|\\'", ""))
                        .append("** permission.");
            } else {
                sb.append("This api is **public**");
            }
            sb.append("<br /><br />");
            sb.append(operation.getDescription());
            operation.setDescription(sb.toString());
            return operation;
        };
    }
}
© www.soinside.com 2019 - 2024. All rights reserved.