cn.msuno.swagger.spring.boot.autoconfigure.plugins.SwaggerParameterBuilderPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-spring-boot-starter Show documentation

Project for Spring Boot

There is a newer version: 2.5.2

Show newest version

package cn.msuno.swagger.spring.boot.autoconfigure.plugins;

import java.util.Objects;

import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import cn.msuno.javadoc.docs.ClassJavadoc;
import cn.msuno.javadoc.docs.MethodJavadoc;
import cn.msuno.javadoc.docs.ParamJavadoc;
import springfox.documentation.RequestHandler;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.ParameterBuilderPlugin;
import springfox.documentation.spi.service.contexts.ParameterContext;

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SwaggerParameterBuilderPlugin extends SwaggerBuilderPlugin implements ParameterBuilderPlugin {
    
    @Override
    public void apply(ParameterContext parameterContext) {
        Object requestContext = readValue(parameterContext.getOperationContext(), "requestContext");
        RequestHandler handler = (RequestHandler)readValue(requestContext, "handler");
        Class clz = handler.declaringClass();
        String name = handler.getName();
        ClassJavadoc javadoc = getOrCreate(clz);
        String parameterName = parameterContext.resolvedMethodParameter().defaultName().orNull();
        if (Objects.isNull(parameterName)) {
            return ;
        }
        String description = parameterName;
        for (MethodJavadoc methodJavadoc : javadoc.getMethods()) {
            if (name.equals(methodJavadoc.getName())) {
                for (ParamJavadoc paramJavadoc : methodJavadoc.getParams()){
                    if (parameterName.equals(paramJavadoc.getName())) {
                        parameterName = paramJavadoc.getName();
                        description = paramJavadoc.getComment().toString();
                        break;
                    }
                }
                break;
            }
        }
        parameterContext.parameterBuilder().name(parameterName).description(description);
    }
    
    @Override
    public boolean supports(DocumentationType delimiter) {
        return true;
    }
    
    
}