springfox.documentation.swagger.readers.parameter.ParameterRequiredReader.java Source code

Introduction

Here is the source code for springfox.documentation.swagger.readers.parameter.ParameterRequiredReader.java

Source

/*
 *
 *  Copyright 2015 the original author or authors.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *
 */

package springfox.documentation.swagger.readers.parameter;

import com.google.common.base.Optional;
import io.swagger.annotations.ApiParam;
import org.springframework.core.MethodParameter;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.ParameterBuilderPlugin;
import springfox.documentation.spi.service.contexts.ParameterContext;
import springfox.documentation.swagger.common.SwaggerPluginSupport;

import java.lang.annotation.Annotation;

@Component("swaggerParameterRequiredReader")
@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER)
public class ParameterRequiredReader implements ParameterBuilderPlugin {

    @Override
    public void apply(ParameterContext context) {
        MethodParameter methodParameter = context.methodParameter();
        if (getAnnotatedRequired(methodParameter).isPresent()) {
            context.parameterBuilder().required(getAnnotatedRequired(methodParameter).get());
        }
    }

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

    private Optional<Boolean> getAnnotatedRequired(MethodParameter methodParameter) {
        Annotation[] methodAnnotations = methodParameter.getParameterAnnotations();

        // when the type is Optional, the required property of @RequestParam/@RequestHeader doesn't matter,
        // since the value is always a non-null Optional after conversion

        if (null != methodAnnotations) {
            for (Annotation annotation : methodAnnotations) {
                if (annotation instanceof ApiParam) {
                    return Optional.of(((ApiParam) annotation).required());
                }
            }
        }
        return Optional.absent();
    }
}