ANNOUNCEMENT: Voyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas.
Learn more
Docs 菜单

模板应用程序

您可以使用我们预制作的模板应用之一启动并运行 Atlas App Services App。模板应用汇集了 Atlas App Services 提供的许多构建基块,您可以从预构建的应用开始,根据需要进行定制。

注册以部署模板应用程序

您可以使用 Atlas App Services 站点上的用户界面、App Services CLI 或 Admin API 创建模板应用。 选择对您来说最方便的选项标签页。

您可以使用与创建空白应用相同的命令创建模板应用。要了解如何创建 App Services App,请参阅创建应用并按照模板应用的说明进行操作。

创建模板应用后,用户界面会包含 Get the Front-End Code for your Template 部分,其中提供客户端代码,您可以将其下载为 .zip 文件、在Github上查看或通过App Services CLI获取。

您可以使用与创建空白应用相同的命令创建模板应用。要了解如何创建 App Services App,请参阅创建应用并按照模板应用的说明进行操作。

该命令必须包含具有有效模板应用ID值的--template标志:

appservices apps create \
--name "<App Name>" \
--template "<Template App ID>"

您可以使用与创建空白应用相同的端点创建模板应用。 要学习;了解如何创建App Services App,请参阅创建应用并按照模板应用的说明进行操作。

您的 Admin API 请求必须在请求正文中包含有效的template_id值。

curl -X POST \
https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \
-H 'Authorization: Bearer <access_token>' \
-d '{
"name": "<App Name>",
"template_id": "<Template App ID>",
"data_source": {
"name": "mongodb-atlas",
"type": "mongodb-atlas",
"config": {
"clusterName": "<Atlas Cluster Name>"
}
}
}'

有些模板应用自带功能齐全的客户端,方便您在创建自己的应用时探索功能并进行扩展。您可以通过 Atlas App Services 用户界面、Realm CLI 或 GitHub 访问这些客户端。

通过 App Services 用户界面下载客户端代码时,客户端代码不会预先填充 App Services App ID。要使用其中一个客户端,您必须找到要在客户端中使用的应用 ID。按照客户端 README.md 中的 ConfigurationDownload the Client as a Zip File 说明来了解在何处插入 App ID。

创建模板应用时下载客户端

当您使用Atlas App Services用户界面创建模板应用时,用户界面为您提供了三个选项,以便您在创建模板后立即获取客户端代码:

  • 将您的首选客户端下载为 .zip 文件。

  • 使用 App Services CLI 将首选客户端拉取到本地目录。

  • 从Github查看并克隆客户端代码。

选择首选方法后,按照屏幕上的说明操作或克隆存储库以获取客户端代码。

在创建模板应用后的某个时间点下载客户端

如果在首次创建应用时未下载客户端代码,您可以稍后下载。 您的App Services App在主仪表盘上显示“Welcome to Your Application”(欢迎来到您的应用程序)窗格。 此窗格包含一个标签为</> Pull front-end code的按钮。 单击此按钮时,您会看到与首次创建应用时相同的对话框,其中提供了获取客户端的选项。

提示

尚无法在App Services用户界面中下载C++模板应用。 使用CLI或从Github克隆存储库以获取客户端代码。

当您通过 App Services CLI 下载客户端代码时,客户端代码会预先填充您的 App Services App ID。

创建模板应用时下载客户端

当您使用App Services CLI创建模板应用时,它会在您运行创建命令的所有位置自动创建一个包含后端和客户端代码的目录。 或者,您可以使用--local选项指定应用代码下载到的目录。

appservices apps create -n "<App Name>" --template "<Chosen Template App ID>"

目录名称是应用的名称。 在此目录中,您将看到一个包含App Services代码的backend目录,以及一个包含客户端应用程序代码的frontend目录。

在创建模板应用后的某个时间点下载客户端

创建模板应用后,您可以随时使用App Services CLI下载客户端代码。 使用带有--template选项的App Services CLI pull 命令指定要下载的客户端模板。

appservices pull --remote "<App Name>" --template "<Chosen Template App ID>"

使用ID提供客户端应用程序的可用模板的 ID。

Device Sync模板应用客户端可从Github获取。 如果您只需要客户端代码而不需要后端代码,请浏览与您的首选框架或语言相关的Github存储库:

如果克隆这些存储库之一,则客户端代码不会预先填充您的 App Services App ID。 要使用其中一个客户端,您必须创建模板应用找到要在客户端中使用的 App ID 。 按照客户端README.md中的ConfigurationCloning from GitHub说明来了解在何处插入 App ID。

有以下模板可用。 App Services CLI接受appservices apps createappservices pull命令的--template标志使用以下 ID。

id
名称
说明
客户

flex-sync-guides.add-collaborators

灵活同步权限指南:“添加协作者”演示

使用 Node.js 客户端和 App Services 应用进行演示,以使用 Flexible Sync 为 Device Sync 实施动态协作权限策略

flex-sync-guides.restricted-feed

Flexible Sync 权限指南:“受限源”演示

使用 Node.js 客户端和 App Services 应用进行演示,以使用 Flexible Sync 为 Device Sync 实施受限新闻源权限策略

flex-sync-guides.tiered

Flexible Sync 权限指南:“分层”演示

使用 Node.js 客户端和 App Services 应用进行演示,以使用 Flexible Sync 为 Device Sync 实施分层特权权限策略

cpp.todo.flex

C++ SDK + Atlas Device Sync Starter

使用 C++ SDK FTXUI 以C++编写的终端 GUI 待办事项清单应用 。使用Device Sync和Flexible Sync将本地数据同步到MongoDB Atlas 。

C++

flutter.todo.flex

Flutter SDK + Atlas Device Sync Starter

使用Flutter SDK用Dart编写的跨平台待办事项清单应用,适用于 Android、 iOS、 Windows、MacOS 和Linux 。 使用Device Sync和Flexible Sync将本地数据同步到MongoDB Atlas 。

Flutter

kotlin.todo.flex

Kotlin SDK + Atlas Device Sync Starter

使用Kotlin SDK以 Kotlin 编写的 Android 待办事项清单应用。 使用 Device Sync 和Flexible Sync 将本地数据同步到 MongoDB Atlas。

Kotlin

maui.todo.flex

MAUI + Atlas Device Sync Starter

使用C# SDK的跨平台待办事项清单移动应用。 使用 Device Sync 和Flexible Sync 将本地数据同步到 MongoDB Atlas。

MAUI

react-native.todo.flex

React Native + Atlas Device Sync Starter

使用JavaScript SDK @realm/React 的跨平台待办事项清单移动应用 库。使用 Device Sync 和Flexible Sync 将本地数据同步到 MongoDB Atlas。

Realm React

swiftui.todo.flex

SwiftUI + Atlas Device Sync Starter

使用 SwiftUI 和Swift SDK的 iOS 待办事项清单应用。 使用 Device Sync 和Flexible Sync 将本地数据同步到 MongoDB Atlas。

SwiftUI

sync.todo

Flexible Sync 待办事项应用后端

仅后端应用,包含 <Language or Framework>.todo.flex 模板应用使用的配置。

triggers

管理数据库视图

事件驱动的数据库触发器模板,用于更新单独集合中的视图。

web.mql.todo

Web SDK + React Starter

React/MQL

web.data-api.todo

Atlas Data API + React Starter

使用 Data API 的托管待办事项清单应用。

React/HTTPS