概览
“概览”章节原生 Neon Auth、JWT 访问,以及面向 Capacitor 的基础 Data API 辅助函数
从 initialize();参见 快速入门 以了解核心方法和示例。
平台支持
标题为“平台支持”的部分| 平台 | 支持 | 备注 |
|---|---|---|
| iOS | 是 | 原生 |
| Android | 是 | 原生 |
| Web 端 | 否 | 使用 Capacitor.getPlatform() 做保护 |
兼容性
“兼容性”章节| 插件版本 | Capacitor 兼容性 | 持续维护 |
|---|---|---|
| v8.*.* | v8.*.* | 是 |
插件主版本号与 Capacitor 匹配(Capacitor 8 对应插件 v8)。仅最新主版本获得积极维护。
核心功能
标题为“核心功能”的章节- 原生 Neon Auth 客户端初始化。
- 邮箱/密码登录与注册。
- Email OTP、OAuth(Google、GitHub、Vercel)以及 session 辅助函数。
- 原生 auth 状态监听器。
- 用于 JavaScript 或后端调用的 JWT 访问。
- 面向未登录用户的匿名数据 API token。
- 基础原生
select,insert,update,以及delete辅助功能,通过 Neon Data API 提供。
推荐架构
标题为“推荐架构”的章节| 关注点 | 推荐路径 |
|---|---|
| 身份验证 | 使用 @capgo/capacitor-neon. |
| 会话持久化与刷新 | 使用 @capgo/capacitor-neon. |
| 高级数据库查询 | 使用 @neondatabase/neon-js 配合原生 JWT 使用。 |
| Neon Functions 或你自己的 API | 将原生 JWT 作为 Bearer token 发送。 |
| 文件上传 | 使用 Neon 对象存储 通过 Neon Function 或您的 API。存储凭据保留在服务器上。 |
| AI 功能 | 调用 Neon AI 网关 通过 Neon Function 或您的 API。请勿将网关令牌放入应用 bundle 中。 |
单一事实来源
标题为“单一事实来源”的部分此参考文档同步自 src/definitions.ts 中的 capacitor-neon.
从 @capgo/capacitor-neon 继续
标题为“从 @capgo/capacitor-neon 继续”的章节如果你正在使用 @capgo/capacitor-neon 来规划安全与合规,请结合 加密 了解 Encryption 的实现细节, 合规性 了解合规部分的实现细节, Capgo 安全扫描器 了解 Capgo Security Scanner 的产品工作流, Capgo 安全 用于 Capgo 安全的产品工作流,以及 Capgo 信任中心 用于 Capgo 信任中心的产品工作流。