Amplify API 包使 Flutter 应用能够使用 GraphQL 和 REST 协议与后端 API 进行交互。它与 AWS Amplify 无缝集成,提供统一的接口来发起 API 调用、处理身份验证以及管理数据同步。该包专为跨平台使用而设计,支持 Android、iOS、Web、macOS、Windows 和 Linux,使开发者能够在各种设备上构建一致的用户体验。该包通过抽象底层网络细节并提供类型安全的查询和变更操作,简化了 API 操作。
适合场景
使用 AWS 支持的 GraphQL API 构建应用
在Flutter应用中集成REST端点
启用与云服务的离线数据同步
使用 AWS Cognito 实现安全的 API 访问
使用共享 API 逻辑创建跨平台应用程序
主要特点
支持 GraphQL 和 REST API 操作
通过 AWS Cognito 的内置身份验证
离线数据同步
类型安全的 API 查询和变更
跨平台兼容性
适合对象
使用 AWS Amplify 的 Flutter 开发人员
需要安全云API集成的应用程序
需要离线优先功能的项目
构建多平台应用程序的团队
使用 GraphQL 或 REST 后端的开发人员
使用建议
需要 AWS Amplify 配置设置
取决于 AWS 账户和 IAM 权限
可能需要为自定义标头或错误处理进行额外设置
最适合已经使用 AWS Amplify 服务的项目
仅限 AWS 托管的后端集成
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
Amplify Flutter
AWS Amplify provides a declarative and easy-to-use interface across different categories of cloud operations. Our default implementation works with Amazon Web Services (AWS), but AWS Amplify is designed to be open and pluggable for any custom backend or service. See AWS Amplify for further details about the Amplify Framework.
We are iterating and looking for feedback and collaboration, so please let us know your feedback on our direction and roadmap.
⚠️ Amplify Flutter v1 is deprecated as of April 30th, 2025. No new features or bug fixes will be added. Dependencies may become outdated and potentially introduce compatibility issues.
Please use the latest version (Gen 2) of Amplify Flutter. If you are currently using v1, follow these instructions to upgrade to v2.
Easily collect analytics data for your app with Pinpoint. Analytics data includes user sessions and other custom events that you want to track in your app.
A programming model for leveraging shared and distributed data without writing additional code for offline and online scenarios, which makes working with distributed, cross-user data just as simple as working with local-only data.
Provides a simple solution when making HTTP requests. It provides an automatic, lightweight signing process which complies with AWS Signature Version 4.
The Amplify Flutter Authenticator simplifies the process of authenticating users by providing a fully-customizable flow which just works. Simply wrap your app's authenticated route in an Authenticator component and the process of authenticating users and managing login sessions is handled for you.
When Amplify adds a new enumeration entry or sealed class subtype, we will publish a new minor version of the library.
Applications that use a switch statement to evaluate all members of an enumerated type can add a default clause to prevent
new cases from causing compile warnings or errors.
Open your Flutter project. If you do not have an active Flutter project, you can create one after installing the Flutter development tooling and running flutter create <project-name> in your terminal.
Run the following to create an amplify project:
npm create amplify@latest -y
To use the Authenticator, you need to add the following dependencies to your project:
Deploy your backend use Amplify's per-developer cloud sandbox. This feature provides a separate backend environment for every developer on a team, ideal for local development and testing. To run your application with a sandbox environment, you can run the following command:
Since Amplify Flutter supports 6 platforms with Flutter including iOS, Android, Web, and Desktop, some extra configuration may be required for each platform. Check out the Platform Setup guide to make sure you've completed the necessary steps.
Run flutter run to launch your app on the connected device.
Congratulations, you've built your first Amplify app! 🎉
For further documentation and Amplify Category usage, see the documentation.
Flutter and the related logo are trademarks of Google LLC. We are not endorsed by or affiliated with Google LLC.