com.zlyx.easy.swagger.plugins.EasySwaggerOperationModelsProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of easy-swagger Show documentation
An useful tool for java developers when using swagger.
There is a newer version: 4.3.11
package com.zlyx.easy.swagger.plugins;

import static springfox.documentation.schema.ResolvedTypes.resolvedTypeSignature;
import static springfox.documentation.swagger.annotations.Annotations.resolvedTypeFromApiOperation;
import static springfox.documentation.swagger.common.SwaggerPluginSupport.pluginDoesApply;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import com.fasterxml.classmate.ResolvedType;
import com.fasterxml.classmate.TypeResolver;

import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.OperationModelsProviderPlugin;
import springfox.documentation.spi.service.contexts.RequestMappingContext;
import springfox.documentation.swagger.common.SwaggerPluginSupport;
import springfox.documentation.swagger.readers.operation.SwaggerOperationModelsProvider;

@Component
@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER + 1)
public class EasySwaggerOperationModelsProvider implements OperationModelsProviderPlugin {

	private static final Logger logger = LoggerFactory.getLogger(SwaggerOperationModelsProvider.class);

	private final TypeResolver typeResolver;

	@Autowired
	public EasySwaggerOperationModelsProvider(TypeResolver typeResolver) {
		this.typeResolver = typeResolver;
	}

	@Override
	public void apply(RequestMappingContext context) {
		collectFromApiOperation(context);
		collectApiResponses(context);
	}

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

	private void collectFromApiOperation(RequestMappingContext context) {
		ResolvedType returnType = context.getReturnType();
		returnType = context.alternateFor(returnType);
		Optional returnParameter = context.findAnnotation(ApiOperation.class)
				.map(resolvedTypeFromApiOperation(typeResolver, returnType));
		if (returnParameter.isPresent() && returnParameter.get() != returnType) {
			logger.debug("Adding return parameter of type {}",
					resolvedTypeSignature(returnParameter.get()).orElse(""));
			context.operationModelsBuilder().addReturn(returnParameter.get());
		}
	}

	private void collectApiResponses(RequestMappingContext context) {
		List allApiResponses = context.findAnnotations(ApiResponses.class);
		logger.debug("Reading parameters models for handlerMethod |{}|", context.getName());
		Set seenTypes = new HashSet<>();
		for (ApiResponses apiResponses : allApiResponses) {
			List modelTypes = toResolvedTypes(context).apply(apiResponses);
			for (ResolvedType modelType : modelTypes) {
				if (!seenTypes.contains(modelType)) {
					seenTypes.add(modelType);
					context.operationModelsBuilder().addReturn(modelType);
				}
			}
		}
	}

	private Function> toResolvedTypes(final RequestMappingContext context) {
		return input -> {
			List resolvedTypes = new ArrayList<>();
			for (ApiResponse response : input.value()) {
				ResolvedType modelType = context.alternateFor(typeResolver.resolve(response.response()));
				logger.debug("Adding input parameter of type {}", resolvedTypeSignature(modelType).orElse(""));
				resolvedTypes.add(modelType);
			}
			return resolvedTypes;
		};
	}

}