Spring Boot集成Swagger3默认不显示Controller接口summary如何配置

你只需要添加一个自定义操作定制器的配置类，即可实现无需为每个接口添加@Operation(summary)注解，自动用方法名作为接口默认summary，同时还会保留你手动配置的summary不被覆盖：

1. 新增Spring配置类，注入OperationCustomizer Bean：

import org.springdoc.core.customizers.OperationCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.HandlerMethod;

@Configuration
public class SpringDocDefaultSummaryConfig {

    @Bean
    public OperationCustomizer defaultSummaryCustomizer() {
        return (operation, handlerMethod) -> {
            // 仅当接口未手动设置summary时，使用方法名作为默认值
            if (operation.getSummary() == null) {
                operation.setSummary(handlerMethod.getMethod().getName());
            }
            return operation;
        };
    }
}

配置完成后重启项目即可生效，所有未加@Operation(summary)注解的接口，都会自动展示方法名作为summary。

如果你不需要保留手动配置的summary优先级，也可以直接在配置文件中开启operationId展示，效果近似：

• application.yml配置：

springdoc:
  swagger-ui:
    display-operation-id: true

• application.properties配置：

springdoc.swagger-ui.display-operation-id=true

内容的提问来源于stack exchange，提问作者Elmir Huseynov