All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.swagger.parser.util.InlineModelResolver Maven / Gradle / Ivy

There is a newer version: 2.0.0-rc1
Show newest version
package io.swagger.parser.util;

import io.swagger.models.*;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.Parameter;
import io.swagger.models.properties.*;
import io.swagger.models.utils.PropertyModelConverter;
import io.swagger.util.Json;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class InlineModelResolver {
    private Swagger swagger;
    private boolean skipMatches;
    static Logger LOGGER = LoggerFactory.getLogger(InlineModelResolver.class);

    Map addedModels = new HashMap();
    Map generatedSignature = new HashMap();

    public void flatten(Swagger swagger) {
        this.swagger = swagger;

        if (swagger.getDefinitions() == null) {
            swagger.setDefinitions(new HashMap());
        }

        // operations
        Map paths = swagger.getPaths();
        Map models = swagger.getDefinitions();

        if (paths != null) {
            for (String pathname : paths.keySet()) {
                Path path = paths.get(pathname);

                for (Operation operation : path.getOperations()) {
                    List parameters = operation.getParameters();

                    if (parameters != null) {
                        for (Parameter parameter : parameters) {
                            if (parameter instanceof BodyParameter) {
                                BodyParameter bp = (BodyParameter) parameter;
                                if (bp.getSchema() != null) {
                                    Model model = bp.getSchema();
                                    if (model instanceof ModelImpl) {
                                        ModelImpl obj = (ModelImpl) model;
                                        if (obj.getType() == null || "object".equals(obj.getType())) {
                                            if (obj.getProperties() != null && obj.getProperties().size() > 0) {
                                                flattenProperties(obj.getProperties(), pathname);
                                                String modelName = resolveModelName(obj.getTitle(), bp.getName());
                                                bp.setSchema(new RefModel(modelName));
                                                addGenerated(modelName, model);
                                                swagger.addDefinition(modelName, model);
                                            }
                                        }
                                    } else if (model instanceof ArrayModel) {
                                        ArrayModel am = (ArrayModel) model;
                                        Property inner = am.getItems();

                                        if (inner instanceof ObjectProperty) {
                                            ObjectProperty op = (ObjectProperty) inner;
                                            if (op.getProperties() != null && op.getProperties().size() > 0) {
                                                flattenProperties(op.getProperties(), pathname);
                                                String modelName = resolveModelName(op.getTitle(), bp.getName());
                                                Model innerModel = modelFromProperty(op, modelName);
                                                String existing = matchGenerated(innerModel);
                                                if (existing != null) {
                                                    RefProperty refProperty = new RefProperty(existing);
                                                    refProperty.setRequired(op.getRequired());
                                                    am.setItems(refProperty);
                                                } else {
                                                    RefProperty refProperty = new RefProperty(modelName);
                                                    refProperty.setRequired(op.getRequired());
                                                    am.setItems(refProperty);
                                                    addGenerated(modelName, innerModel);
                                                    swagger.addDefinition(modelName, innerModel);
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                    Map responses = operation.getResponses();
                    if (responses != null) {
                        for (String key : responses.keySet()) {
                            Response response = responses.get(key);
                            if (response.getSchema() != null) {
                                Property property = response.getSchema();
                                if (property instanceof ObjectProperty) {
                                    ObjectProperty op = (ObjectProperty) property;
                                    if (op.getProperties() != null && op.getProperties().size() > 0) {
                                        String modelName = resolveModelName(op.getTitle(), "inline_response_" + key);
                                        Model model = modelFromProperty(op, modelName);
                                        String existing = matchGenerated(model);
                                        if (existing != null) {
                                            Property refProperty = this.makeRefProperty(existing, property);
                                            refProperty.setRequired(op.getRequired());
                                            response.setResponseSchema(new PropertyModelConverter().propertyToModel(refProperty));
                                        } else {
                                            Property refProperty = this.makeRefProperty(modelName, property);
                                            refProperty.setRequired(op.getRequired());
                                            response.setResponseSchema(new PropertyModelConverter().propertyToModel(refProperty));
                                            addGenerated(modelName, model);
                                            swagger.addDefinition(modelName, model);
                                        }
                                    }
                                } else if (property instanceof ArrayProperty) {
                                    ArrayProperty ap = (ArrayProperty) property;
                                    Property inner = ap.getItems();

                                    if (inner instanceof ObjectProperty) {
                                        ObjectProperty op = (ObjectProperty) inner;
                                        if (op.getProperties() != null && op.getProperties().size() > 0) {
                                            flattenProperties(op.getProperties(), pathname);
                                            String modelName = resolveModelName(op.getTitle(),
                                                    "inline_response_" + key);
                                            Model innerModel = modelFromProperty(op, modelName);
                                            String existing = matchGenerated(innerModel);
                                            if (existing != null) {
                                                Property refProperty = this.makeRefProperty(existing, op);
                                                refProperty.setRequired(op.getRequired());
                                                ap.setItems(refProperty);
                                                response.setResponseSchema(new PropertyModelConverter().propertyToModel(ap));
                                            } else {
                                                Property refProperty = this.makeRefProperty(modelName, op);
                                                refProperty.setRequired(op.getRequired());
                                                ap.setItems(refProperty);
                                                response.setResponseSchema(new PropertyModelConverter().propertyToModel(ap));
                                                addGenerated(modelName, innerModel);
                                                swagger.addDefinition(modelName, innerModel);
                                            }
                                        }
                                    }
                                } else if (property instanceof MapProperty) {
                                    MapProperty mp = (MapProperty) property;

                                    Property innerProperty = mp.getAdditionalProperties();
                                    if (innerProperty instanceof ObjectProperty) {
                                        ObjectProperty op = (ObjectProperty) innerProperty;
                                        if (op.getProperties() != null && op.getProperties().size() > 0) {
                                            flattenProperties(op.getProperties(), pathname);
                                            String modelName = resolveModelName(op.getTitle(),
                                                    "inline_response_" + key);
                                            Model innerModel = modelFromProperty(op, modelName);
                                            String existing = matchGenerated(innerModel);
                                            if (existing != null) {
                                                RefProperty refProperty = new RefProperty(existing);
                                                refProperty.setRequired(op.getRequired());
                                                mp.setAdditionalProperties(refProperty);
                                                response.setResponseSchema(new PropertyModelConverter().propertyToModel(mp));
                                            } else {
                                                RefProperty refProperty = new RefProperty(modelName);
                                                refProperty.setRequired(op.getRequired());
                                                mp.setAdditionalProperties(refProperty);
                                                response.setResponseSchema(new PropertyModelConverter().propertyToModel(mp));
                                                addGenerated(modelName, innerModel);
                                                swagger.addDefinition(modelName, innerModel);
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }

        // definitions
        if (models != null) {
            List modelNames = new ArrayList(models.keySet());
            for (String modelName : modelNames) {
                Model model = models.get(modelName);
                if (model instanceof ModelImpl) {
                    ModelImpl m = (ModelImpl) model;

                    Map properties = m.getProperties();
                    flattenProperties(properties, modelName);
                    fixStringModel(m);
                } else if (model instanceof ArrayModel) {
                    ArrayModel m = (ArrayModel) model;
                    Property inner = m.getItems();
                    if (inner instanceof ObjectProperty) {
                        ObjectProperty op = (ObjectProperty) inner;
                        if (op.getProperties() != null && op.getProperties().size() > 0) {
                            String innerModelName = resolveModelName(op.getTitle(), modelName + "_inner");
                            Model innerModel = modelFromProperty(op, innerModelName);
                            String existing = matchGenerated(innerModel);
                            if (existing == null) {
                                swagger.addDefinition(innerModelName, innerModel);
                                addGenerated(innerModelName, innerModel);
                                RefProperty refProperty = new RefProperty(innerModelName);
                                refProperty.setRequired(op.getRequired());
                                m.setItems(refProperty);
                            } else {
                                RefProperty refProperty = new RefProperty(existing);
                                refProperty.setRequired(op.getRequired());
                                m.setItems(refProperty);
                            }
                        }
                    }
                } else if (model instanceof ComposedModel) {
                    ComposedModel m = (ComposedModel) model;
                    if (m.getChild() != null) {
                        Map properties = m.getChild().getProperties();
                        flattenProperties(properties, modelName);
                    }
                }
            }
        }
    }

    /**
     * This function fix models that are string (mostly enum). Before this fix, the example
     * would look something like that in the doc: "\"example from def\""
     * @param m Model implementation
     */
    private void fixStringModel(ModelImpl m) {
        if (m.getType() != null && m.getType().equals("string") && m.getExample() != null) {
            String example = m.getExample().toString();
            if (!example.isEmpty() && example.substring(0, 1).equals("\"") &&
                    example.substring(example.length() - 1).equals("\"")) {
                m.setExample(example.substring(1, example.length() - 1));
            }
        }
    }

    private String resolveModelName(String title, String key) {
        if (title == null) {
            return uniqueName(key);
        } else {
            return uniqueName(title);
        }
    }

    public String matchGenerated(Model model) {
        if (this.skipMatches) {
            return null;
        }
        String json = Json.pretty(model);
        if (generatedSignature.containsKey(json)) {
            return generatedSignature.get(json);
        }
        return null;
    }

    public void addGenerated(String name, Model model) {
        generatedSignature.put(Json.pretty(model), name);
    }

    public String uniqueName(String key) {
        int count = 0;
        boolean done = false;
        key = key.replaceAll("[^a-z_\\.A-Z0-9 ]", ""); // FIXME: a parameter
        // should not be
        // assigned. Also declare
        // the methods parameters
        // as 'final'.
        while (!done) {
            String name = key;
            if (count > 0) {
                name = key + "_" + count;
            }
            if (swagger.getDefinitions() == null) {
                return name;
            } else if (!swagger.getDefinitions().containsKey(name)) {
                return name;
            }
            count += 1;
        }
        return key;
    }

    public void flattenProperties(Map properties, String path) {
        if (properties == null) {
            return;
        }
        Map propsToUpdate = new HashMap();
        Map modelsToAdd = new HashMap();
        for (String key : properties.keySet()) {
            Property property = properties.get(key);
            if (property instanceof ObjectProperty && ((ObjectProperty) property).getProperties() != null
                    && ((ObjectProperty) property).getProperties().size() > 0) {

                ObjectProperty op = (ObjectProperty) property;

                String modelName = resolveModelName(op.getTitle(), path + "_" + key);
                Model model = modelFromProperty(op, modelName);

                String existing = matchGenerated(model);

                if (existing != null) {
                    RefProperty refProperty = new RefProperty(existing);
                    refProperty.setRequired(op.getRequired());
                    propsToUpdate.put(key, refProperty);
                } else {
                    RefProperty refProperty = new RefProperty(modelName);
                    refProperty.setRequired(op.getRequired());
                    propsToUpdate.put(key, refProperty);
                    modelsToAdd.put(modelName, model);
                    addGenerated(modelName, model);
                    swagger.addDefinition(modelName, model);
                }
            } else if (property instanceof ArrayProperty) {
                ArrayProperty ap = (ArrayProperty) property;
                Property inner = ap.getItems();

                if (inner instanceof ObjectProperty) {
                    ObjectProperty op = (ObjectProperty) inner;
                    if (op.getProperties() != null && op.getProperties().size() > 0) {
                        flattenProperties(op.getProperties(), path);
                        String modelName = resolveModelName(op.getTitle(), path + "_" + key);
                        Model innerModel = modelFromProperty(op, modelName);
                        String existing = matchGenerated(innerModel);
                        if (existing != null) {
                            RefProperty refProperty = new RefProperty(existing);
                            refProperty.setRequired(op.getRequired());
                            ap.setItems(refProperty);
                        } else {
                            RefProperty refProperty = new RefProperty(modelName);
                            refProperty.setRequired(op.getRequired());
                            ap.setItems(refProperty);
                            addGenerated(modelName, innerModel);
                            swagger.addDefinition(modelName, innerModel);
                        }
                    }
                }
            } else if (property instanceof MapProperty) {
                MapProperty mp = (MapProperty) property;
                Property inner = mp.getAdditionalProperties();

                if (inner instanceof ObjectProperty) {
                    ObjectProperty op = (ObjectProperty) inner;
                    if (op.getProperties() != null && op.getProperties().size() > 0) {
                        flattenProperties(op.getProperties(), path);
                        String modelName = resolveModelName(op.getTitle(), path + "_" + key);
                        Model innerModel = modelFromProperty(op, modelName);
                        String existing = matchGenerated(innerModel);
                        if (existing != null) {
                            RefProperty refProperty = new RefProperty(existing);
                            refProperty.setRequired(op.getRequired());
                            mp.setAdditionalProperties(refProperty);
                        } else {
                            RefProperty refProperty = new RefProperty(modelName);
                            refProperty.setRequired(op.getRequired());
                            mp.setAdditionalProperties(refProperty);
                            addGenerated(modelName, innerModel);
                            swagger.addDefinition(modelName, innerModel);
                        }
                    }
                }
            } else if (property instanceof ComposedProperty) {
                ComposedProperty composedProperty = (ComposedProperty) property;
                String modelName = resolveModelName(composedProperty.getTitle(), path + "_" + key);
                Model model = modelFromProperty(composedProperty, modelName);
                String existing = matchGenerated(model);
                if (existing != null) {
                    RefProperty refProperty = new RefProperty(existing);
                    refProperty.setRequired(composedProperty.getRequired());
                    propsToUpdate.put(key, refProperty);
                } else {
                    RefProperty refProperty = new RefProperty(modelName);
                    refProperty.setRequired(composedProperty.getRequired());
                    propsToUpdate.put(key, refProperty);
                    addGenerated(modelName, model);
                    swagger.addDefinition(modelName, model);
                }
            }
        }
        if (propsToUpdate.size() > 0) {
            for (String key : propsToUpdate.keySet()) {
                properties.put(key, propsToUpdate.get(key));
            }
        }
        for (String key : modelsToAdd.keySet()) {
            swagger.addDefinition(key, modelsToAdd.get(key));
            this.addedModels.put(key, modelsToAdd.get(key));
        }
    }

    @SuppressWarnings("static-method")
    public Model modelFromProperty(ArrayProperty object, @SuppressWarnings("unused") String path) {
        String description = object.getDescription();
        String example = null;

        Object obj = object.getExample();
        if (obj != null) {
            example = obj.toString();
        }

        Property inner = object.getItems();
        if (inner instanceof ObjectProperty) {
            ArrayModel model = new ArrayModel();
            model.setDescription(description);
            model.setExample(example);
            model.setItems(object.getItems());
            if (object.getVendorExtensions() != null) {
                for (String key : object.getVendorExtensions().keySet()) {
                    model.setVendorExtension(key, object.getVendorExtensions().get(key));
                }
            }

            return model;
        }

        return null;
    }

    public Model modelFromProperty(ObjectProperty object, String path) {
        String description = object.getDescription();
        String example = null;

        Object obj = object.getExample();
        if (obj != null) {
            example = obj.toString();
        }
        String name = object.getName();
        Xml xml = object.getXml();
        Map properties = object.getProperties();

        ModelImpl model = new ModelImpl();
        model.type(object.getType());
        model.setDescription(description);
        model.setExample(example);
        model.setName(name);
        model.setXml(xml);
        if (object.getVendorExtensions() != null) {
            for (String key : object.getVendorExtensions().keySet()) {
                model.setVendorExtension(key, object.getVendorExtensions().get(key));
            }
        }

        if (properties != null) {
            flattenProperties(properties, path);
            model.setProperties(properties);
        }

        return model;
    }

    public Model modelFromProperty(ComposedProperty composedProperty, String path) {
        String description = composedProperty.getDescription();
        String example = null;

        Object obj = composedProperty.getExample();
        if (obj != null) {
            example = obj.toString();
        }
        Xml xml = composedProperty.getXml();

        ModelImpl model = new ModelImpl();
        model.type(composedProperty.getType());
        model.setDescription(description);
        model.setExample(example);
        model.setName(path);
        model.setXml(xml);
        if (composedProperty.getVendorExtensions() != null) {
            for (String key : composedProperty.getVendorExtensions().keySet()) {
                model.setVendorExtension(key, composedProperty.getVendorExtensions().get(key));
            }
        }
        return model;
    }

    @SuppressWarnings("static-method")
    public Model modelFromProperty(MapProperty object, @SuppressWarnings("unused") String path) {
        String description = object.getDescription();
        String example = null;

        Object obj = object.getExample();
        if (obj != null) {
            example = obj.toString();
        }

        ArrayModel model = new ArrayModel();
        model.setDescription(description);
        model.setExample(example);
        model.setItems(object.getAdditionalProperties());
        if (object.getVendorExtensions() != null) {
            for (String key : object.getVendorExtensions().keySet()) {
                model.setVendorExtension(key, object.getVendorExtensions().get(key));
            }
        }

        return model;
    }

    /**
     * Make a RefProperty
     *
     * @param ref new property name
     * @param property Property
     * @return {@link Property} A constructed Swagger property
     */
    public Property makeRefProperty(String ref, Property property) {
        RefProperty newProperty = new RefProperty(ref);
        this.copyVendorExtensions(property, newProperty);
        return newProperty;
    }

    /**
     * Copy vendor extensions from Property to another Property
     *
     * @param source source property
     * @param target target property
     */
    public void copyVendorExtensions(Property source, AbstractProperty target) {
        Map vendorExtensions = source.getVendorExtensions();
        for (String extName : vendorExtensions.keySet()) {
            target.setVendorExtension(extName, vendorExtensions.get(extName));
        }
    }

    public boolean isSkipMatches() {
        return skipMatches;
    }

    public void setSkipMatches(boolean skipMatches) {
        this.skipMatches = skipMatches;
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy