Kris
a66ecad0f9
- 更新 environment.js 中 initSlaveDatasource 函数参数从 environmentCode 改为 environmentId - 更新 SourceEnvironmentTab.vue 中的初始化从库功能以使用 environmentId - 在 TargetEnvironmentTab.vue 中添加完整的初始化从库功能 - 初始化项目单一真源（SSOT）文档结构，包括： - 创建主 index.md 作为项目单一真源 - 创建 Authentication.canvas 可视化文件 - 创建所有必需的文档目录和 README.md 文件 - 建立完整的双向索引关系
5.1 KiB
5.1 KiB
API 文档：语言管理功能
元数据
- 需求编号：2026-01-21-002-08
- 创建时间：2026-01-26
- 创建人：SSOT 架构师
- 父需求：2026-01-21-002-项目国际化需求
API 概述
语言管理功能 API 提供了对系统支持语言的增删改查、启用停用、默认语言设置等功能。管理员可以通过这些接口维护系统的多语言支持列表。
接口列表
接口 1：查询语言列表
功能描述
分页查询语言列表，支持按语言代码、语言名称、状态进行筛选。
请求方式
GET
请求路径
/system/language/list
权限要求
system:language:list
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| pageNum | Integer | 否 | 页码，默认 1 |
| pageSize | Integer | 否 | 每页数量，默认 10 |
| langCode | String | 否 | 语言代码（模糊匹配） |
| langName | String | 否 | 语言名称（模糊匹配） |
| status | String | 否 | 状态（0正常 1停用） |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码（200 成功） |
| msg | String | 提示信息 |
| rows | Array | 数据列表 |
| total | Integer | 总记录数 |
接口 2：获取语言详细信息
功能描述
根据 ID 获取语言的详细信息。
请求方式
GET
请求路径
/system/language/{id}
权限要求
system:language:query
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| id | Long | 是 | 语言 ID |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| data | Object | 语言对象信息 |
接口 3：新增语言
功能描述
新增一种系统支持的语言。
请求方式
POST
请求路径
/system/language
权限要求
system:language:add
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| langCode | String | 是 | 语言代码（如 zh-CN） |
| langName | String | 是 | 语言名称 |
| langNameEn | String | 是 | 语言英文名称 |
| sortOrder | Integer | 否 | 排序 |
| status | String | 否 | 状态（0正常 1停用） |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| msg | String | 提示信息 |
接口 4：修改语言
功能描述
修改已有的语言信息。
请求方式
PUT
请求路径
/system/language
权限要求
system:language:edit
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| id | Long | 是 | 语言 ID |
| langCode | String | 是 | 语言代码 |
| langName | String | 是 | 语言名称 |
| ... | ... | ... | 其他可修改字段 |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| msg | String | 提示信息 |
接口 5：删除语言
功能描述
删除一种或多种语言。
请求方式
DELETE
请求路径
/system/language/{ids}
权限要求
system:language:remove
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| ids | Long[] | 是 | 语言 ID 数组（路径参数） |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| msg | String | 提示信息 |
接口 6：设置默认语言
功能描述
将指定语言设置为系统默认语言。
请求方式
PUT
请求路径
/system/language/default/{id}
权限要求
system:language:default
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| id | Long | 是 | 语言 ID |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| msg | String | 提示信息 |
接口 7：修改语言状态
功能描述
启用或停用某种语言。
请求方式
PUT
请求路径
/system/language/status
权限要求
system:language:status
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| id | Long | 是 | 语言 ID |
| status | String | 是 | 状态（0正常 1停用） |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| msg | String | 提示信息 |
接口 8：获取默认语言
功能描述
获取当前系统的默认语言配置。
请求方式
GET
请求路径
/system/language/default
权限要求
- 无（通常公开或需登录）
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| data | Object | 默认语言对象 |
接口 9：刷新语言缓存
功能描述
强制刷新语言相关的 Redis 缓存。
请求方式
DELETE
请求路径
/system/language/cache
权限要求
system:language:cache
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码 |
| msg | String | 提示信息 |