# 自定义字典数据源
低代码开发平台默认提供了内置的字典管理功能,但是对于希望自己开发管理字典系统的项目,我们也提供了自定义字典数据源的方法。
# 配置
只需要在后端的 config.yml 文件中增加以下配置即可将 IDE 和运行时的字典查询接口指向用户自定义的接口。
dictionaryBaseUrl: "https://example.com/your-dicts-url"
配置完成后,需确保访问对应的接口能返回字典列表数据。
# 数据结构
返回的字典列表数据类型声明如下:
/**
* 接口返回数据类型
*/
type ReturnDataType = Dictionary[]
/**
* 字典集
*/
interface Dictionary {
/**
* 字典集唯一标识
*/
id: string;
/**
* 用于设计器中对用户显示
*/
title: string;
/**
* 选项列表
*/
items: DictionaryItem[]
}
/**
* 字典集选项
*/
interface DictionaryItem {
/**
* 显示名称,最终用户可见
*/
title: string;
/**
* 保存编码
*/
value: string | number | boolean;
}
# 注意
当配置完 dictionaryBaseUrl 之后,将不再需要内置的字典管理功能,可以按照 功能扩展 中的指引将 字典 功能设置为 disabled。