平台设置
平台设置是 Chameleon 面向开发者与管理员提供的平台级配置中心,集中管理租户、集成、扩展以及运维工具等与具体业务无关的全局能力。
概述
从 开发中心 → 开发设置 进入平台设置页面。页面采用页签(Tab)方式组织,每个页签对应一类设置能力。为了便于查找,平台设置按用途划分为四个分组:
| 分组 | 定位 | 包含页签 |
|---|---|---|
| 租户与设置 | 平台租户的授权、基础参数与配置文件 | 租户授权、系统设置、租户配置 |
| 集成与开放 | 对外集成与开放接口 | OAuth2.0、OpenAPI 文档 |
| 扩展与自动化 | 平台功能扩展与自动化任务 | 插件、任务管理、页面模板 |
| 开发工具 | 面向开发/运维的诊断与维护工具 | 开发工具、系统工具 |
部分页签的可见性受租户类型与权限控制:
- 租户授权仅对公共租户(
common)可见。 - 系统工具仅对公共租户或静态租户(
IsStaticTenant)可见。
分组与文档导航
租户与设置
面向多租户运营的基础配置,用于管理租户生命周期、租户级运行参数以及开发用的配置文件。
| 能力 | 说明 | 文档 |
|---|---|---|
| 租户管理 | 租户的新增、编辑、详情、数据库连接与租户初始化 | 租户管理 |
| 租 户开发设置 | 自定义域名、企业微信、AI 模型等租户级参数 | 租户开发设置 |
| 租户配置 | 以 JSON 形式预置 API 密钥、连接串等固定配置 | 租户配置文件 |
集成与开放
面向外部系统集成的凭据与接口。
| 能力 | 说明 | 文档 |
|---|---|---|
| OAuth 客户端 | 创建与维护第三方接入凭证(Client ID / Client Secret) | OAuth 客户端 |
| OpenAPI 文档 | 在线查看与调试平台开放接口,见 OpenAPI | |
| OpenAPI | 平台对外开放接口总览与认证方式 | OpenAPI |
| 应用互联 | 与企业微信等系统互联 | 企业微信配置 |
| 第三方接入 | OAuth 2.0 授权码接入流程 | OAuth 2.0 |
扩展与自动化
通过插件扩展平台能力,通过任务与模板实现自动化。
| 能力 | 说明 | 文档 |
|---|---|---|
| 插件 | 扩展登录、初始密码等标准能力 | 插件 |
| 任务管理 | 创建与维护周期性执行的定时任务 | 定时任务 |
| 页面模板 | 以可视化布局编辑器复用页面结构 | 页面模板 |
开发工具
面向开发者与运维的诊断、维护工具,通常具有较高风险,请谨慎使用。
| 能力 | 说明 | 文档 |
|---|---|---|
| 开发工具 | 缓存管理、元数据迁移/删除、密钥生成、CBC 加解密 | 开发工具 |
| 系统工具 | 按租户批量执行平台内置的维护脚本 | 系统工具 |
下一步
页签与技术说明
以下内容面向技术实现与 AI 检索。
页签标识
平台设置各页签由 tab 查询参数驱动,页面地址形如 /Dev/DevelopmentSetting?tab={key}。页签标识与对应组件如下:
| 页签标识(key) | 显示名称 | 组件 | 可见条件 |
|---|---|---|---|
MetaScheduleJobList | 任务管理 | MetaScheduleJobList | 全部开发者 |
MetaPageTemplateList | 页面模板 | MetaPageTemplateList | 全部开发者 |
ChameleonPlugin | 插件 | ChameleonPluginList | 全部开发者 |
OAuthClient | OAuth2.0 | OAuthClientList | 全部开发者 |
TenantDevSettingBasic | 系统设置 | TenantDevSettingBasic | 全部开发者 |
TenantConfig | 租户配置 | TenantConfig | 全部开发者 |
OpenApiSwagger | OpenAPI 文档 | OpenApiSwagger | 全部开发者 |
DeveloperTools | 开发工具 | DeveloperTools | 全部开发者 |
SystemTools | 系统工具 | SystemTools | 公共租户或静态租户 |
TenantList | 租户授权 | TenantList | 公共租户 |
默认页签
未显式传入 tab 时,默认打开 MetaScheduleJobList(任务管理)。
租户可见性判定
| 变量 | 判定逻辑 |
|---|---|
| 公共租户 | window.chameleon.tenant_id === 'common'(consts.CommonTenantId) |
| 静态租户 | 租户设置项 IsStaticTenant 为 true(access.isStaticTenant) |
通用设置存储模型
「系统设置」与「租户配置」均通过 TenantSetting 读写,接口为 POST /api/TenantSetting/EditTenantSetting 与 GET /api/TenantSetting/GetTenantDevSettings。
{
"key": "CustomDomain",
"value": "https://example.com",
"isDev": true
}
| 属性 | 类型 | 含义 |
|---|---|---|
Key | string | 设置项键名 |
Value | string | 设置项值(统一以字符 串存储) |
IsDev | bool | 是否为开发设置;开发设置在开发设置页维护 |
相关接口
| 接口 | 说明 |
|---|---|
GET /api/TenantSetting/GetTenantDevSettings | 获取当前租户的开发设置 |
POST /api/TenantSetting/EditTenantSetting | 保存单个设置项 |
POST /api/SystemTool/GetMetadata | 获取系统工具元数据 |
POST /api/SystemTool/Execute | 执行系统工具 |
GET /api/TenantInfo/GetAllTenantIdList | 获取全部租户 ID 列表 |