@d8d-appcontainer/api

D8D AppContainer API 客户端

这个包提供了与 D8D AppContainer 服务进行交互的 API 客户端。

安装

npm install @d8d-appcontainer/api

基本使用

import { APIClientFactory } from '@d8d-appcontainer/api';

// 创建系统客户端
const systemClient = APIClientFactory.createSystemClient({
  endpoint: 'https://your-endpoint.com',
  token: 'your-token'
});

// 创建用户客户端
const userClient = APIClientFactory.createUserClient({
  endpoint: 'https://your-endpoint.com',
  token: 'your-token'
});

// 等待连接
await systemClient.connect();

// 使用服务
const result = await systemClient.database.query('your-collection', {});

可用服务

客户端提供以下服务：

系统客户端 (SystemAPIClient)

• database: 数据库服务 - 详细文档
• workspace: 工作空间服务 - 详细文档
• auth: 认证服务 - 详细文档
• deploy: 部署服务 - 详细文档
• storage: 存储服务 - 详细文档
• stats: 统计服务 - 详细文档
• billing: 计费服务 - 详细文档
• redis: Redis 服务 - 详细文档
• socket: Socket 服务 - 详细文档
• sms: 短信服务 - 详细文档
• wechat: 微信服务 - 详细文档

用户客户端 (UserAPIClient)

• database: 数据库服务 - 详细文档
• auth: 认证服务 - 详细文档
• deploy: 部署服务 - 详细文档
• storage: 存储服务 - 详细文档
• stats: 统计服务 - 详细文档
• billing: 计费服务 - 详细文档
• redis: Redis 服务 - 详细文档
• socket: Socket 服务 - 详细文档

核心模块

• 核心模块 - 提供基础API和连接管理功能
• 客户端模块 - 提供API客户端和工厂方法

工具函数

API 客户端还提供了以下工具函数：

• uploadMinIOWithPolicy: 使用策略上传文件到 MinIO
• uploadOSSWithPolicy: 使用策略上传文件到 OSS

类型

该库导出以下主要类型：

• SystemAPIClient, UserAPIClient: 客户端类型
• AppContainerBaseConfig, QueryOptions, APIResponse, ErrorCode, SchemaAPI: 基础配置和响应类型
• Transaction: 数据库事务类型
• WechatWebUserInfo, WechatMiniUserInfo: 微信用户信息类型

导出的类和API

• BaseAPI: 所有API服务的基类
• ConnectionManager: 处理与服务器的连接
• ErrorHandler: 统一错误处理
• APIClient: 客户端基类
• APIClientFactory: 创建不同类型客户端的工厂
• QueryBuilder: SQL查询构建器