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

Question

基本上我的问题与此相同，但针对 Springdoc （而不是 Springfox）。

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

有没有办法可以根据注解自动修改具体的资源swagger描述？我想这与重写 Springdoc 的默认类行为之一有关（也许OpenAPICustomiser？），但我不确定如何做到这一点。

Answer 1

好吧，我已经想出了这样的办法-

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;
        };
    }
}