java swagger参数排序_java spring springfox swagger 2 模型字段排序问题

这篇博客主要介绍了如何解决Java Springfox Swagger 2中模型字段排序的问题。通过实现CustomApiModelPropertyPositionBuilder类,利用反射和Apache Commons库来获取并设置字段的排序位置,确保Swagger生成的API文档中参数按预期顺序展示。
摘要由CSDN通过智能技术生成

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 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 (beanPropertyDefinitionOpt.isPresent()) {

BeanPropertyDefinition beanPropertyDefinition = beanPropertyDefinitionOpt.get();

if (annotation.isPresent() && annotation.get().position() != 0) {

return;

}

AnnotatedField field = beanPropertyDefinition.getField();

Class> clazz = field.getDeclaringClass();

Field[] declaredFields = clazz.getDeclaredFields();

Field declaredField;

try {

declaredField = clazz.getDeclaredField(field.getName());

} catch (NoSuchFieldException | SecurityException e) {

log.error("", e);

return;

}

int indexOf = ArrayUtils.indexOf(declaredFields, declaredField);

if (indexOf != -1) {

context.getBuilder().position(indexOf);

}

}

}

}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值