程序包 cn.sinozg.applet.common.customizer

类 EnumFieldCustomizer

java.lang.Object

cn.sinozg.applet.common.customizer.EnumFieldCustomizer

所有已实现的接口:

org.springdoc.core.customizers.PropertyCustomizer

@Component
public class EnumFieldCustomizer
extends Object
implements org.springdoc.core.customizers.PropertyCustomizer

将字段的枚举值写入到 swagger

从以下版本开始:

2023-12-10 12:04

作者:

xieyubin

字段概要

字段

修饰符和类型	字段	说明
static final org.slf4j.Logger	log

构造器概要

构造器

构造器	说明
EnumFieldCustomizer()

方法概要

修饰符和类型	方法	说明
io.swagger.v3.oas.models.media.Schema<?>	customize(io.swagger.v3.oas.models.media.Schema property, io.swagger.v3.core.converter.AnnotatedType type)
private String	dictPair(DictTrans dict)	dict 键对值
private String	enumInfo(cn.sinozg.applet.common.annotation.EnumField ef)	获取枚举值的键值对
private String	wrapUp(StringBuilder info, boolean error, boolean isDict)	转html 语言

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

log

public static final org.slf4j.Logger log

构造器详细资料

EnumFieldCustomizer

public EnumFieldCustomizer()

方法详细资料

customize

public io.swagger.v3.oas.models.media.Schema<?> customize(io.swagger.v3.oas.models.media.Schema property,
 io.swagger.v3.core.converter.AnnotatedType type)

指定者:

customize 在接口中 org.springdoc.core.customizers.PropertyCustomizer

enumInfo

private String enumInfo(cn.sinozg.applet.common.annotation.EnumField ef)
                 throws Exception

获取枚举值的键值对

参数:

ef - 枚举值

返回:

信息

抛出:

Exception - 异常

dictPair

private String dictPair(DictTrans dict)

dict 键对值

参数:

dict - dict

返回:

数据

wrapUp

private String wrapUp(StringBuilder info,
 boolean error,
 boolean isDict)

转html 语言

参数:

info - 键对值信息

error - 是否错误

返回:

文本