Springfox （swagger） - 如何添加动态属性

Question

我正在尝试在我的java spring项目中的swagger定义中添加新的属性。我已阅读文档并特别 https://springfox.github.io/springfox/docs/snapshot/#plugins

import java.util.HashMap;
import java.util.Map;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import com.fasterxml.classmate.ResolvedType;
import com.fasterxml.classmate.TypeResolver;
import com.google.common.base.Predicates;
import fr.hop.springdatarest.demo.entity.City;
import lombok.extern.java.Log;
import springfox.documentation.builders.ModelPropertyBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.Model;
import springfox.documentation.schema.ModelProperty;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.schema.ModelBuilderPlugin;
import springfox.documentation.spi.schema.contexts.ModelContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.common.SwaggerPluginSupport;

@Log
@Component
@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER + 1008)
public class SwaggerDefinitionAddin implements ModelBuilderPlugin {

    @Autowired
    TypeResolver resolver;

    Map<String, ModelProperty> cityAddinMap = new HashMap<String, ModelProperty>();

    @Override
    public boolean supports(DocumentationType delimiter) {
        return DocumentationType.SWAGGER_2.equals(delimiter);
    }

    private Class<?> forClass(ModelContext context) {
        return resolver.resolve(context.getType()).getErasedType();
    }

    @Override
    public void apply(ModelContext modelContext) {

        if(forClass(modelContext) == City.class){

            modelContext.getBuilder().id("TEST").properties(????).build();
        }       
    }

}

例如，我有这个定义：

"definitions": {
    "City": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "postalCode": {
          "type": "integer",
          "format": "int32"
        }
      }
    },

我想要:

"definitions": {
    "City": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "postalCode": {
          "type": "integer",
          "format": "int32"
        },
        "meteo": {
          "$ref": "#/definitions/Meteo"
        }
      }
    },

你能帮我在定义中添加meteo属性吗？在本例中，我的目标是以编程方式添加attribute，而不使用注释。

Answer 1

@Component
@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER + 1008)
public class SwaggerDefinitionAddin implements ModelBuilderPlugin {

    @Autowired
    TypeResolver resolver;

    @Autowired 
    TypeNameExtractor typeNameExtractor;

    Map<String, ModelProperty> propertyAddinMap = new HashMap<String, ModelProperty>();



    @Override
    public boolean supports(DocumentationType delimiter) {
        return DocumentationType.SWAGGER_2.equals(delimiter);
    }

    private Class<?> forClass(ModelContext context) {
        return resolver.resolve(context.getType()).getErasedType();
    }

    @Override
    public void apply(ModelContext modelContext) {

        boolean cityScope = false;
        Class<?> modelClass = forClass(modelContext);

        // Detect if it is City modelcontext type instance
        if(modelClass == City.class) {
            cityScope = true;
        }
        // Or an Hateoas resource pointing on City instance
        else if(modelClass.equals(Resource.class)){
            ResolvedType resourceResolveType = resolver.resolve(modelContext.getType()).getTypeBindings().getTypeParameters().get(0);
            if(resourceResolveType.getErasedType().equals(City.class))
                cityScope = true;
        }

        // Add meteo definition in City definition and ResourceCity definition
        if(cityScope){

            ModelPropertyBuilder builder = new ModelPropertyBuilder();
            ModelProperty meteoProperty = builder               
                .name("meteo")
                .type(resolver.resolve(Meteo.class))
                .required(true)
                .isHidden(false)                
                .position(0)                
                .build();

            meteoProperty.updateModelRef(modelRefFactory(modelContext, typeNameExtractor));
            propertyAddinMap.put("meteo",meteoProperty);

            modelContext.getBuilder()           
                .name("City")               
                .properties(propertyAddinMap)
                .build();               
        }       
    }
}

我很难找到springfox生成NPE的原因，在查看源代码后，我发现我们必须设置modelRef：

meteoProperty.updateModelRef(modelRefFactory(modelContext, typeNameExtractor));

希望帮助别人:)