基础44 JavaScript SDK
Base44 SDK提供JavaScript接口,用于在Base44平台上构建应用程序.
你可以用两种方式:
- Base44软件内部:当 Base44 生成您的应用程序时,SDK已经设置并准备使用.
- 外部应用程序:使用SDK来构建自己的前端或后端,使用Base44作为后端服务.
安装
Base44软件内部: SDK已经可用. 无需安装.
外部应用程序: 通过 npm 安装 SDK :
npm install @base44/sdk
模块
SDK通过下列模块提供对 Base44 功能的访问:
agents:与AI代理进行互动并管理对话.analytics:在您的应用程序中跟踪自定义事件.app-logs: 访问和查询应用程序日志.auth: 管理用户认证,注册,和会话处理.connectors: 为第三方服务管理OAuth连接和访问符.entities: 与您的应用程序使用 CRUD 操作的数据实体合作.functions:执行后端功能.integrations: 接入预建和第三方集成.payments:嵌入式出票,查购,并按服务角色处理退款及订阅.
快速启动
你是如何开始的取决于你是在Base44生成的应用软件内工作,还是在自己建造.
Base44软件内部
在 Base44 生成的应用程序中,客户端被预配置. 只需导入并使用 :
import { base44 } from "@/api/base44Client";
// Create a new task
const newTask = await base44.entities.Task.create({
title: "Complete project documentation",
status: "pending",
dueDate: "2024-12-31",
});
// Update the task
await base44.entities.Task.update(newTask.id, {
status: "in-progress",
});
// List all tasks
const tasks = await base44.entities.Task.list();
外部应用程序
当使用Base44作为自己应用程序的后端时,安装了SDK并自己创建客户端:
import { createClient } from "@base44/sdk";
// Create a client for your Base44 app
const base44 = createClient({
appId: "your-app-id", // Find this in the Base44 editor URL
});
// Read public data
const products = await base44.entities.Products.list();
// Authenticate a user (token is automatically set)
await base44.auth.loginViaEmailPassword("[email protected]", "password");
// Access user's data
const userOrders = await base44.entities.Orders.list();
服务作用
默认情况下,客户端使用用户级权限进行操作,限制了对当前用户所能看到和做的事情的访问. 服务角色为后端操作提供更高的权限,并仅在Base44托管后端功能中提供. 外部后端不能使用服务角色权限.
import { createClientFromRequest } from "npm:@base44/sdk";
Deno.serve(async (req) => {
const base44 = createClientFromRequest(req);
// Access all data with admin-level permissions
const allOrders = await base44.asServiceRole.entities.Orders.list();
return Response.json({ orders: allOrders });
});
学多点
用JavaScript SDK开始的最好方法是让Base44为您建立一个应用程序. 一旦有了应用程序,就可以探索生成的代码并用SDK进行实验,看看它在实践中是如何工作的. 也可以请Base44演示SDK的具体特征.
为了加深理解,请查看这些指南:
欲了解完整的文件和API的参考资料,请访问 Base44 开发者文档。 。 。 .
发展
构建 SDK
从源代码构建 SDK :
npm install
npm run build
运行测试
运行测试套件 :
# Run all tests
npm test
# Run unit tests only
npm run test:unit
# Run with coverage
npm run test:coverage
对于E2E测试,创建一个 tests/.env 文件为 :
BASE44_APP_ID=your_app_id
BASE44_AUTH_TOKEN=your_auth_token
生成文档
本地生成 API 文档 :
# Process and preview locally
npm run create-docs
cd docs
mintlify dev