capital.scalable.restdocs.payload.JacksonResponseFieldSnippet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-auto-restdocs-core Show documentation
Spring Auto REST Docs is an extension to Spring REST Docs
The newest version!
/*-
 * #%L
 * Spring Auto REST Docs Core
 * %%
 * Copyright (C) 2015 - 2021 Scalable Capital GmbH
 * %%
 * 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.
 * #L%
 */
package capital.scalable.restdocs.payload;

import static capital.scalable.restdocs.SnippetRegistry.AUTO_RESPONSE_FIELDS;
import static capital.scalable.restdocs.util.TypeUtil.firstGenericType;

import java.lang.reflect.GenericArrayType;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import capital.scalable.restdocs.i18n.SnippetTranslationResolver;
import capital.scalable.restdocs.jackson.FieldDescriptors;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.springframework.http.HttpEntity;
import org.springframework.restdocs.operation.Operation;
import org.springframework.web.method.HandlerMethod;

public class JacksonResponseFieldSnippet extends AbstractJacksonFieldSnippet {

    private final static Set SPRING_PAGE_CLASSES = new HashSet<>(Arrays.asList(
            "org.springframework.data.domain.Page",
            "org.springframework.hateoas.PagedModel"
    ));
    public static final Set SPRING_HATEOAS_CLASSES = new HashSet<>(Arrays.asList(
            "org.springframework.hateoas.Resource",
            "org.springframework.hateoas.EntityModel"
    ));
    public static final String REACTOR_MONO_CLASS = "reactor.core.publisher.Mono";
    public static final String REACTOR_FLUX_CLASS = "reactor.core.publisher.Flux";

    private final Type responseBodyType;
    private final boolean failOnUndocumentedFields;

    public JacksonResponseFieldSnippet() {
        this(null, false);
    }

    public JacksonResponseFieldSnippet(Type responseBodyType, boolean failOnUndocumentedFields) {
        super(AUTO_RESPONSE_FIELDS, null);
        this.responseBodyType = responseBodyType;
        this.failOnUndocumentedFields = failOnUndocumentedFields;
    }

    public JacksonResponseFieldSnippet responseBodyAsType(Type responseBodyType) {
        return new JacksonResponseFieldSnippet(responseBodyType, failOnUndocumentedFields);
    }

    public JacksonResponseFieldSnippet failOnUndocumentedFields(boolean failOnUndocumentedFields) {
        return new JacksonResponseFieldSnippet(responseBodyType, failOnUndocumentedFields);
    }

    @Override
    protected Type[] getType(final HandlerMethod method) {
        if (responseBodyType != null) {
            return new Type[]{responseBodyType};
        }

        Class methodReturnType = method.getReturnType().getParameterType();
        Type returnType;
        if (HttpEntity.class.isAssignableFrom(methodReturnType)) {
            returnType = firstGenericType(method.getReturnType());
        } else if (SPRING_PAGE_CLASSES.contains(methodReturnType.getCanonicalName())) {
            returnType = firstGenericType(method.getReturnType());
        } else if (SPRING_HATEOAS_CLASSES.contains(methodReturnType.getCanonicalName())) {
            returnType = firstGenericType(method.getReturnType());
        } else if (isCollection(methodReturnType)) {
            returnType = (GenericArrayType) () -> firstGenericType(method.getReturnType());
        } else if ("void".equals(methodReturnType.getName())) {
            returnType = null;
        } else if (REACTOR_MONO_CLASS.equals(methodReturnType.getCanonicalName())) {
            Type type = firstGenericType(method.getReturnType());
            if (type instanceof ParameterizedType) {
                // can be Mono>
                returnType = ((ParameterizedType) type).getActualTypeArguments()[0];
            } else {
                returnType = type;
            }
        } else if (REACTOR_FLUX_CLASS.equals(methodReturnType.getCanonicalName())) {
            returnType = (GenericArrayType) () -> firstGenericType(method.getReturnType());
        } else if (method.getReturnType().getGenericParameterType() instanceof TypeVariable) {
            returnType =  firstGenericType(method.getReturnType());
        } else {
            returnType = methodReturnType;
        }
        return returnType == null ? null : new Type[]{returnType};
    }

    @Override
    protected void enrichModel(Map model, HandlerMethod handlerMethod,
            FieldDescriptors fieldDescriptors, SnippetTranslationResolver translationResolver) {
        model.put("isPageResponse", isPageResponse(handlerMethod));
        if (fieldDescriptors.getNoContentMessageKey() != null) {
            model.put("no-response-body", translationResolver.translate(fieldDescriptors.getNoContentMessageKey()));
        }
    }

    private boolean isPageResponse(HandlerMethod handlerMethod) {
        return SPRING_PAGE_CLASSES.contains(
                handlerMethod.getReturnType().getParameterType().getCanonicalName());
    }

    @Override
    public String getHeaderKey(Operation operation) {
        return "response-fields";
    }

    @Override
    protected boolean shouldFailOnUndocumentedFields() {
        return failOnUndocumentedFields;
    }

    @Override
    protected String[] getTranslationKeys() {
        return new String[]{
                "th-path",
                "th-type",
                "th-optional",
                "th-description",
                "pagination-response-adoc",
                "pagination-response-md",
                "no-response-body"
        };
    }

    @Override
    protected JsonProperty.Access getSkipAcessor() {
        return JsonProperty.Access.WRITE_ONLY;
    }
}