星空云开发 Serverless 文档

1平台定义

星空云开发 是一个 Serverless 云开发平台（BaaS，后端即服务）。它把传统后端所需的服务器、数据库、接口、认证等基础设施全部托管到云端，开发者不需要购买服务器、不需要配置环境，创建项目即可获得一套完整可用的后端能力。

2平台组件

每个项目内置以下组件，全部通过统一网关（Gateway）对外提供。

3连接客户端

3.1 你需要的信息

3.2 认证方式

所有 API 请求都需要在请求头带上密钥：

Authorization: Bearer <你的API Key>
Content-Type: application/json
apikey: <你的API Key>

3.3 数据库 REST 接口

数据库表通过 REST API 读写（风格与 Supabase 兼容）：

# 查询表数据
GET  {网关地址}/rest/v1/表名?select=*

# 插入数据
POST {网关地址}/rest/v1/表名
# 请求体：{"字段": "值"}

# 更新数据
PATCH {网关地址}/rest/v1/表名?字段=eq.值

# 删除数据
DELETE {网关地址}/rest/v1/表名?字段=eq.值

3.4 云函数调用

POST {网关地址}/functions/函数名
# 请求体：函数入参 JSON

3.5 认证接口

# 注册 / 登录由平台统一处理，客户端调用：
POST {网关地址}/auth/v1/signup   # 邮箱+验证码注册
POST {网关地址}/auth/v1/login    # 登录获取 JWT

4SDK 使用教程与代码示例

平台提供 JavaScript SDK、微信小程序 SDK 与 安卓 SDK（Java / Kotlin）。SDK 已内置你的项目地址与密钥，下载后只需一行初始化即可使用，不需要写任何连接代码。下载入口：控制台 → 项目详情 → SDK 接入。

4.1 引入 SDK

4.2 JavaScript SDK

// 引入：script 直链 / 文件引入用 window.Xingkong；模块化项目用 import（方式见 4.1）
// import Xingkong from './utils/xingkong-sdk.js';
const xk = window.Xingkong;

// ① 数据库读写（REST 风格，兼容 Supabase 写法）
// 查询（支持 eq / select / order / limit 链式组合）
const todos = await xk.db.from("todos")
  .eq("done", false)
  .select("*")
  .order("created_at", true)
  .limit(20)
  .get();
// 新增
await xk.db.from("todos").insert({ title: "学习星空云开发", done: false });
// 更新 / 删除（eq 过滤条件后 update / remove）
await xk.db.from("todos").eq("id", "1").update({ done: true });
await xk.db.from("todos").eq("id", "1").remove();

// ② 用户认证
await xk.auth().register("user@example.com", "123456", { nickname: "星空" });
await xk.auth().login("user@example.com", "123456");
const me = await xk.auth().me();   // 当前登录用户
xk.logout();

// ③ 验证码（发送 / 校验）
await xk.otp().send("user@example.com", { scene: "register" });
await xk.otp().verify("user@example.com", "123456");

// ④ 云函数
const result = await xk.functions().invoke("hello", { name: "星空" });

// ⑤ 云存储（上传 / 列表 / 下载 / 删除）
await xk.storage().upload("img/logo.png", fileInput.files[0]);
const list = await xk.storage().list("img");
const bytes = await xk.storage().download("img/logo.png");  // ArrayBuffer
await xk.storage().remove("img/logo.png");
// 拼接下载直链：xk.storage().url("img/logo.png")

// ⑥ 实时推送
const ws = xk.realtime().connect("channel_1", msg => console.log("收到消息", msg));

// 其他：更换连接地址（如配了反代）
xk.setBaseUrl("https://你的中转地址");

4.3 安卓 SDK（Java）

一行初始化（地址与密钥已内置），其余全部是异步回调：

// 初始化（已内置项目地址与密钥）
XingkongClient xk = XingkongClient.init(this);

// ① 数据库读写（异步回调）
xk.db.from("todos").eq("done", "false").select("*").order("created_at", true).limit(20)
  .get((res, err) -> {
    if (err != null) { Log.e("SDK", err.getMessage()); return; }
    List<Map<String, Object>> rows = (List<Map<String, Object>>) res;
  });
// 新增 / 更新 / 删除
xk.db.from("todos").insert(row, (res, err) -> { });
xk.db.from("todos").eq("id", "1").update(row, (res, err) -> { });
xk.db.from("todos").eq("id", "1").delete((res, err) -> { });

// ② 用户认证
xk.auth().register("user@example.com", "123456", null, (res, err) -> { });
xk.auth().login("user@example.com", "123456", (res, err) -> { });
xk.auth().me(xk.getRestToken(), (res, err) -> { });
xk.logout();

// ③ 验证码
xk.otp().send("user@example.com", null, (res, err) -> { });
xk.otp().verify("user@example.com", "123456", (res, err) -> { });

// ④ 云函数
xk.invokeFunction("hello", java.util.Collections.singletonMap("name", "星空"), (res, err) -> { });

// ⑤ 云存储
xk.storage().upload("img/logo.png", "logo.png", bytes, (res, err) -> { });
xk.storage().list("img", (res, err) -> { });
xk.storage().download("img/logo.png", (res, err) -> { });  // res 为 byte[]
xk.storage().delete("img/logo.png", (res, err) -> { });

4.4 Kotlin（安卓）

// 用法与 Java 一致，一行初始化
val xk = XingkongClient.init(this)

xk.db.from("todos").eq("done", "false").select("*").get { res, err -> /* 处理结果 */ }
xk.invokeFunction("hello", mapOf("name" to "星空")) { res, err -> }
xk.otp().send("user@example.com", null) { res, err -> }

4.5 微信小程序 SDK

下载小程序 SDK（控制台 → 项目详情 → SDK 接入），放入小程序项目 utils/ 目录，require 引入即可使用（地址与密钥已内置，无需任何连接配置）：

// 引入（utils/xingkong-sdk-wx.js 为下载的小程序 SDK）
const xk = require('../../utils/xingkong-sdk-wx.js');

// 用法与网页 JS SDK 完全一致，全部为 Promise
// ① 数据库
const todos = await xk.db.from("todos").eq("done", false).select("*").limit(20).get();
await xk.db.from("todos").insert({ title: "小程序测试" });

// ② 用户认证 / 验证码
await xk.auth().register("user@example.com", "123456", { nickname: "星空" });
await xk.auth().login("user@example.com", "123456");
await xk.otp().send("user@example.com");

// ③ 云函数
const result = await xk.functions().invoke("hello", { name: "星空" });

// ④ 云存储（上传传本地临时文件路径，下载返回临时路径）
const res = await wx.chooseImage({ count: 1 });   // 选择图片
await xk.storage().upload("img/logo.png", res.tempFilePaths[0]);
const tmp = await xk.storage().download("img/logo.png");   // 临时文件路径，可 wx.saveFile 保存
const list = await xk.storage().list("img");
await xk.storage().remove("img/logo.png");

4.6 密钥安全（重要）

5配额与用量说明