com.github.kongchen.swagger.docgen.jaxrs.BeanParamInjectParamExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-maven-plugin Show documentation

A maven build plugin which helps you generate API document during build phase

The newest version!

package com.github.kongchen.swagger.docgen.jaxrs;

import com.github.kongchen.swagger.docgen.reader.AbstractReader;
import com.github.kongchen.swagger.docgen.reader.JaxrsReader;
import com.google.common.collect.Lists;
import com.sun.jersey.api.core.InjectParam;
import com.sun.jersey.core.header.FormDataContentDisposition;
import io.swagger.jaxrs.ext.AbstractSwaggerExtension;
import io.swagger.jaxrs.ext.SwaggerExtension;
import io.swagger.models.parameters.Parameter;
import org.apache.commons.lang3.reflect.TypeUtils;

import javax.ws.rs.BeanParam;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

/**
 * This extension extracts the parameters inside a {@code @BeanParam} by
 * expanding the target bean type's fields/methods/constructor parameters and
 * recursively feeding them back through the {@link JaxrsReader}.
 *
 * @author chekong on 15/5/9.
 */
public class BeanParamInjectParamExtension extends AbstractSwaggerExtension {


    private AbstractReader reader;

    public BeanParamInjectParamExtension(AbstractReader reader) {
        this.reader = reader;
    }

    @Override
    public List extractParameters(List annotations, Type type, Set typesToSkip, Iterator chain) {
        Class cls = TypeUtils.getRawType(type, type);

        if (shouldIgnoreClass(cls) || typesToSkip.contains(type)) {
            // stop the processing chain
            typesToSkip.add(type);
            return Lists.newArrayList();
        }
        for (Annotation annotation : annotations) {
            if (annotation instanceof BeanParam || annotation instanceof InjectParam) {
                return reader.extractTypes(cls, typesToSkip, Lists.newArrayList());
            }
        }
        return super.extractParameters(annotations, type, typesToSkip, chain);
    }

    @Override
    public boolean shouldIgnoreClass(Class cls) {
        return FormDataContentDisposition.class.equals(cls);
    }
}