微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

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

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

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

有没有办法可以根据注解自动修改特定资源的swagger描述?我想这与覆盖 Springdoc 的认类行为之一(可能是 OpenAPICustomiser?)有关,但我不知道该怎么做。

解决方法

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

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

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。