3keycompany/czertainly-frontend-administrator

CZERTAINLY管理员用户界面

本仓库是商业开源项目CZERTAINLY的一部分。可在https://github.com/CZERTAINLY/CZERTAINLY%E4%BB%93%E5%BA%93%E8%8E%B7%E5%8F%96%E6%9B%B4%E5%A4%9A%E9%A1%B9%E7%9B%AE%E4%BF%A1%E6%81%AF%EF%BC%8C%E5%8C%85%E6%8B%AC%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97%E3%80%82

管理员用户界面（通常称为Admin UI）是一个管理Web界面，管理员可通过该界面在平台上执行各种管理任务。

核心功能与特性

对象详情

链接和页面的构建方式便于页面间导航。用户只需点击对象名称，即可跳转到该对象的详情视图以查看其详细信息。

图标与工具提示

为便于理解和使用，图标均配有工具提示，用户可在需要时了解图标提供的操作功能。

操作功能

大多数对象可从其列表页执行批量操作。对于单个对象（如连接器）的操作，用户可在列表页或详情页进行。

更多信息请参考CZERTAINLY文档。

生成API类型

本节提供从OpenAPI规范生成DTO和API的TypeScript类的指南，包括一些必要的自定义操作。

步骤1：生成TypeScript数据传输对象（DTO）

要从OpenAPI规范生成TypeScript数据传输对象（DTO），使用以下命令。该命令将生成类型并使用Prettier格式化生成的文件。

sh
npm run generate-types

步骤2：修复生成代码中的类型错误

有时，生成的代码可能会遇到类型错误，例如：

sh
Type 'PaginationRequestDto' is not assignable to type 'string | number | boolean | (string | number | boolean)[]'.ts(2322)
(property) 'paginationRequestDto': PaginationRequestDto

原始生成代码：

sh
const query: HttpQuery = { // 必填参数已通过throwIfNullOrUndefined检查，因此直接使用
    'paginationRequestDto': paginationRequestDto,
};

修复类型错误的更新代码：

sh
const query: HttpQuery = {};
if (paginationRequestDto != null) {
    Object.assign(query, paginationRequestDto);
}

此更改确保仅当paginationRequestDto不为null或undefined时才将其分配给query，从而避免类型错误。

步骤3：手动向DataAttribute接口添加BaseAttributeContentDto

当前，生成OpenAPI模型类型时，BaseAttributeContentDto会从DataAttribute接口中移除。此问题源于内部库在生成层次结构（继承）类型时存在问题。

按以下方式更新DataAttribute接口：

sh
interface DataAttribute {
    # 向DataAttribute接口添加以下属性
    /**
     * 属性内容
     * @type {Array<BaseAttributeContentDto>}
     * @memberof DataAttribute
     */
    content?: Array<BaseAttributeContentDto>;
}

生成类型后，请确保手动将content属性添加回DataAttribute接口。

不要忘记导入BaseAttributeContentDto：

sh
import type {
    AttributeCallback,
    AttributeContentType,
    AttributeType,
    BaseAttributeConstraint, # 添加此导入
    DataAttributeProperties,
} from './';

Docker容器使用说明

管理员Web界面以Docker容器形式提供，可通过以下方式使用：

拉取镜像

使用以下命令从仓库拉取所需镜像：

sh
docker pull czertainly/czertainly-frontend-administrator:tagname

环境变量配置

可通过以下环境变量配置容器：