swagger修改参数和返回结果默认顺序与类属性顺序一致

swagger项目添加下列类后自动生效

package com.n.api.common.dto;
import springfox.documentation.spi.schema.ModelPropertyBuilderPlugin;
import static springfox.documentation.schema.Annotations.findPropertyAnnotation;
import static springfox.documentation.swagger.schema.ApiModelProperties.findApiModePropertyAnnotation;
import java.lang.reflect.Field;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.stereotype.Component;
import com.fasterxml.jackson.databind.introspect.AnnotatedField;
import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
import com.google.common.base.Optional;
import io.swagger.annotations.ApiModelProperty;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.schema.ModelPropertyBuilderPlugin;
import springfox.documentation.spi.schema.contexts.ModelPropertyContext;
import springfox.documentation.swagger.common.SwaggerPluginSupport;

@Component
public class CustomApiModelPropertyPositionBuilder implements ModelPropertyBuilderPlugin {
    private Log log = LogFactory.getLog(getClass());

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

    @Override
    public void apply(ModelPropertyContext context) {
        Optional<BeanPropertyDefinition> beanPropertyDefinitionOpt = context.getBeanPropertyDefinition();
        Optional annotation = Optional.absent();
        if (context.getAnnotatedElement().isPresent())
            annotation = annotation.or(findApiModePropertyAnnotation(context.getAnnotatedElement().get()));
        if (context.getBeanPropertyDefinition().isPresent())
            annotation = annotation.or(findPropertyAnnotation(context.getBeanPropertyDefinition().get(), ApiModelProperty.class));
        if (annotation.isPresent() && beanPropertyDefinitionOpt.isPresent()) {
            BeanPropertyDefinition beanPropertyDefinition = beanPropertyDefinitionOpt.get();
            /*获取到注解字段*/
            AnnotatedField field = beanPropertyDefinition.getField();
            /*获取到字段所在的类*/
            Class clazz = field.getDeclaringClass();
            /*获取类中所有字段*/
            Field[] declaredFields = clazz.getDeclaredFields();
            Field declaredField;
            /*获取当前字段的Field*/
            try {
                declaredField = clazz.getDeclaredField(field.getName());
            } catch (NoSuchFieldException | SecurityException e) {
                log.error("", e);
                return;
            }
            /*获取当前字段在数组中的位置。然后设置position属性*/
            int indexOf = ArrayUtils.indexOf(declaredFields, declaredField);
            if (indexOf != -1) context.getBuilder().position(indexOf);
        }
    }
}

  • 4
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 4
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值