Springfox 和 Avro 生成的 Java 类

Question

我有一些使用 avro 编译器从 avro 模式生成的 java 类。我在我的 Spring Rest 控制器中使用它们并使用 Springfox 来生成一个 openapi 规范。因为生成的 avro 类有 getSchema() 和 getSpecificData() 方法，它们会出现在 openapi 模型中。

有没有办法全局告诉 Springfox不在类中包含某些命名字段？

Answer 1

我找到了一种使用插件的方法：

    @Bean
    public ModelPropertyBuilderPlugin removeAvroFieldsFromSwagger() {
        return new ModelPropertyBuilderPlugin() {
            @Override
            public void apply(ModelPropertyContext context) {
                if( context.getBeanPropertyDefinition().isPresent() ){
                    BeanPropertyDefinition definition = context.getBeanPropertyDefinition().get();
                    if( "schema".equals(definition.getName()) && definition.getPrimaryType().getTypeName().contains("org.apache.avro.Schema")){
                        context.getBuilder().isHidden(true);
                    }
                    else if( "specificData".equals(definition.getName()) && definition.getPrimaryType().getTypeName().contains("org.apache.avro.specific.SpecificData")){
                        context.getBuilder().isHidden(true);
                    }
                }
            }

            @Override
            public boolean supports(DocumentationType delimiter) {
                return true;
            }
        };
    }