swagger中模型排序

原创已于 2024-03-04 17:30:29 修改 · 306 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2024-03-04 17:29:03 首次发布

java 专栏收录该内容

8 篇文章

订阅专栏

本文讲述了如何在SpringBoot项目中使用自定义插件`CustomApiModelPropertyPositionBuilder`，根据`@ApiModelProperty`注解的位置调整Swagger文档中模型属性的显示顺序。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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 org.apache.commons.lang3.ArrayUtils;
import org.springframework.stereotype.Component;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.schema.ModelPropertyBuilderPlugin;
import springfox.documentation.spi.schema.contexts.ModelPropertyContext;
import springfox.documentation.swagger.common.SwaggerPluginSupport;

import java.lang.reflect.Field;

import static springfox.documentation.schema.Annotations.findPropertyAnnotation;
import static springfox.documentation.swagger.schema.ApiModelProperties.findApiModePropertyAnnotation;

@Component
public class CustomApiModelPropertyPositionBuilder implements ModelPropertyBuilderPlugin {

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

	@Override
	public void apply(ModelPropertyContext context) {
		Optional<BeanPropertyDefinition> beanPropertyDefinitionOpt = context.getBeanPropertyDefinition();
		Optional<ApiModelProperty> 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) {
				return;
			}
			int indexOf = ArrayUtils.indexOf(declaredFields, declaredField);
			if (indexOf != -1) {
				context.getBuilder().position(indexOf);
			}
		}
	}
}

拷贝文件到springboot工程中，按照@ApiModelProperty的先后顺序进行排序，否则按照字母先后进行排序