apaas-oapi-client

🚀 aPaaS OpenAPI Node.js 客户端 SDK

封装 aPaaS 平台 RESTful API 的 Node.js SDK，简化接口调用，内置限流与 token 缓存功能。

✨ 功能特性

数据操作

• ✅ records 查询（支持分页迭代）
• ✅ record 单条查询、单条更新、单条删除
• ✅ record 批量创建、批量更新、批量删除

对象结构管理（Schema）

• ✅ 创建数据对象（批量）
• ✅ 更新数据对象（批量，支持添加/修改/删除字段）
• ✅ 删除数据对象（批量）
• ✅ 字段类型完整文档（20+ 字段类型，含示例）

其他功能

• ✅ 获取 accessToken（自动刷新）
• ✅ 导出数据对象文档为 Markdown
• ✅ 内置 Bottleneck 限流器
• ✅ 自定义日志等级

📦 安装

npm install apaas-oapi-client

� 快速开始

创建数据对象

import { apaas } from 'apaas-oapi-client';

const client = new apaas.Client({
    clientId: 'your_client_id',
    clientSecret: 'your_client_secret',
    namespace: 'your_namespace'
});

await client.init();

// 创建数据对象
await client.schema.create({
    objects: [{
        api_name: 'product',
        label: { zh_cn: '产品', en_us: 'Product' },
        settings: {
            display_name: 'code',
            allow_search_fields: ['_id', 'code']
        },
        fields: [
            {
                api_name: 'code',
                label: { zh_cn: '编号', en_us: 'Code' },
                type: { name: 'text', settings: { required: true } },
                encrypt_type: 'none'
            }
        ]
    }]
});

// 更新对象：添加字段
await client.schema.update({
    objects: [{
        api_name: 'product',
        fields: [{
            operator: 'add',  // 添加新字段
            api_name: 'name',
            label: { zh_cn: '名称', en_us: 'Name' },
            type: { name: 'text', settings: { required: true } },
            encrypt_type: 'none'
        }]
    }]
});

📖 使用文档

• 完整说明、初始化示例与 API 用法请查看 UserManual.md
• Schema 管理完整示例请查看 examples/schema-operations.ts
• 关联字段创建示例（lookup/lookup_multi/referenceField/rollup）请查看 examples/schema-reference-fields.ts