功能简介
AppBase 文档同时面对 origin/main、按语言生成的 SDK 与少量本地候选功能。本页规定读者如何识别“已进入 main”“带条件支持”和“仅本地候选”,避免把源码存在、路由存在或候选验收误写成正式发布。
当前支持范围
- REST API(SUPPORTED):核心服务通过版本化 REST API 暴露,每个接口单独声明认证类型、Scope 与响应模型。
- 多语言 SDK(PARTIAL):仓库提供 Web、移动端和多种服务端语言的 SDK 源码、生成产物与类型契约;具体包是否已发布须按语言和版本单独确认。
适用场景
- 核对页面示例适用的服务端与 SDK 版本。
- 判断某能力是否需要实例 Feature Flag、外部 Provider 或额外数据面。
- 区分候选能力与正式发布,避免生产依赖。
前置条件
- 记录正在运行实例的服务端 Commit 或发布版本。
- 从实际 Registry/制品仓确认目标语言 SDK 版本。
- 部署型能力还需核对 Builder、Executor、Proxy、Memory 等依赖。
Console 操作路径
Console 不提供统一的“文档能力状态”页面。请把当前实例版本、Project 服务开关与本文页面顶部的发布状态一起判断;页面存在不等于目标实例已启用。
SDK 示例
SDK · TypeScript
import { Client } from 'appbase-web-sdk';
const client = new Client()
.setEndpoint('https://<APPBASE_HOST>/v1')
.setProject('<PROJECT_ID>');
// SDK 源码可核验不等于 Registry 已发布;安装前确认实际包版本。
console.info(client.config.endpoint);REST 示例
REST · Bash
curl -i 'https://<APPBASE_HOST>/v1/health/version'常见错误
| 现象 | 处理建议 |
|---|---|
| SDK 安装成功但方法不存在 | 核对该语言包的实际版本与生成时间,不要用仓库 HEAD 推断 Registry 版本。 |
| Console 有入口但请求失败 | 检查服务端 Commit、Feature Flag、依赖组件和当前角色。 |
| Candidate 页面与运行实例不一致 | 只有同时匹配 Backend 与 Frontend Candidate Commit 的本地环境才适用。 |
当前限制
- 仓库包含多语言 SDK 源码与生成产物,但不保证每个包都已同步发布。
- GraphQL 不承诺与 REST 全量同构;Realtime 也不是 GraphQL Subscription。
- 本地候选能力在合入 main 前不得写成正式发布。
Appwrite 兼容说明
兼容说明只引用 Appwrite 的分类和技术术语;AppBase 是否实现某项能力,以本内容包 Source Map 的 AppBase 证据为准。
AppBase 增强说明
每页同时给出 capabilityStatus、releaseStatus 与 verifiedCommit;Candidate 页面另外给出 Backend/Frontend Candidate SHA。
发布状态和验证 Commit
origin/main 条件支持。验证 Commit:0363062a1c7ea08741975bb5ba0c3361663c9353;使用前必须同时满足本页“当前限制”。
权威来源文件列表
backend-candidate:app/controllers/api/backend-candidate:docs/references/backend-candidate:packages/sdks/client-*backend-candidate:packages/sdks/server-*backend-candidate:src/Appwrite/Platform/Modules/*/Http/backend-candidate:tests/unit/SDK/origin-main:docs/products/v2.3.x/sdks/
Appwrite taxonomy 仅作信息架构参考:https://appwrite.io/docs、https://appwrite.io/docs/apis/rest、https://appwrite.io/docs/sdks。上游页面不是 AppBase 实现证据。