io.swagger.jackson.SwaggerAnnotationIntrospector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagger-core Show documentation
There is a newer version: 2.0.0-rc2
package io.swagger.jackson;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.AnnotationIntrospector;
import com.fasterxml.jackson.databind.introspect.Annotated;
import com.fasterxml.jackson.databind.introspect.AnnotatedClass;
import com.fasterxml.jackson.databind.introspect.AnnotatedMember;
import com.fasterxml.jackson.databind.jsontype.NamedType;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import javax.xml.bind.annotation.XmlElement;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class SwaggerAnnotationIntrospector extends AnnotationIntrospector {
	private static final long serialVersionUID = 1L;
	private boolean isThereAHiddenField = false;

	@Override
	public Version version() {
		return PackageVersion.VERSION;
	}

	@Override
	public boolean hasIgnoreMarker(AnnotatedMember m) {
		ApiModelProperty ann = m.getAnnotation(ApiModelProperty.class);
		if (ann != null && ann.hidden()) {
			isThereAHiddenField = true;
			return true;
		}
		// Add a Ignore Marker when there's a Constructor with JsonCreator and also if there's any Hidden Field
		JsonCreator constructor = m.getAnnotation(JsonCreator.class);
		if (constructor != null && isThereAHiddenField) {
			return true;
		}
		return false;
	}

	@Override
	public Boolean hasRequiredMarker(AnnotatedMember m) {
		ApiModelProperty ann = m.getAnnotation(ApiModelProperty.class);
		if (ann != null) {
			return ann.required();
		}
		XmlElement elem = m.getAnnotation(XmlElement.class);
		if (elem != null) {
			if (elem.required()) {
				return true;
			}
		}
		return null;
	}

	@Override
	public String findPropertyDescription(Annotated a) {
		ApiModel model = a.getAnnotation(ApiModel.class);
		if (model != null && !"".equals(model.description())) {
			return model.description();
		}
		ApiModelProperty prop = a.getAnnotation(ApiModelProperty.class);
		if (prop != null) {
			return prop.value();
		}
		return null;
	}

	@Override
	public Integer findPropertyIndex(Annotated a) {
		ApiModelProperty prop = a.getAnnotation(ApiModelProperty.class);
		if (prop != null && prop.position() != 0) {
			return prop.position();
		}
		return null;
	}

	@Override
	public List findSubtypes(Annotated a) {
		final ApiModel api = a.getAnnotation(ApiModel.class);
		if (api != null) {
			final Class[] classes = api.subTypes();
			final List names = new ArrayList(classes.length);
			for (Class subType : classes) {
				names.add(new NamedType(subType));
			}
			if (!names.isEmpty()) {
				return names;
			}
		}

		return Collections.emptyList();
	}

	@Override
	public String findTypeName(AnnotatedClass ac) {
		return null;
	}
}