搜索插件、代码仓与 APP 分类

插件详情v2.16.0

amplify_api

支持 GraphQL 和 REST 操作的 Amplify Flutter API 类别插件。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
5.3万
喜欢数
40
Pub 分数
160

安装插件

flutter pub add amplify_api

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

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 原文快照,最新内容请访问源码仓库。

AWS Amplify

discord

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.

Getting Started Guide

⚠️ 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.

Supported Amplify Libraries

Library pub.dev package Description
Authentication APIs and building blocks for developers who want to create user authentication experiences with Amazon Cognito.
Analytics 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.
Storage Provides a simple mechanism for managing user content for your app in public, protected or private storage buckets with Amazon S3.
DataStore 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.
API (REST) Provides a simple solution when making HTTP requests. It provides an automatic, lightweight signing process which complies with AWS Signature Version 4.
API (GraphQL) Interact with your GraphQL server or AWS AppSync API with an easy-to-use & configured GraphQL client.
Notifications Trigger push notifications to your app and record metrics in Pinpoint when users receive or open notifications.
Authenticator 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.
Semantic versioning

We follow semantic versioning for our releases.

Semantic versioning and enumeration cases

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.

Semantic versioning and dependencies update

We follow semantic versioning for updating our dependencies. This includes updating the dart and flutter SDK version.

Category / Platform Support

Category Android iOS Web Windows MacOS Linux
Analytics ✅ ✅ ✅ ✅ ✅ ✅
API (REST) ✅ ✅ ✅ ✅ ✅ ✅
API (GraphQL) ✅ ✅ ✅ ✅ ✅ ✅
Authentication ✅ ✅ ✅ ✅ ✅ ✅
DataStore ✅ ✅ 🔴 🔴 🔴 🔴
Storage ✅ ✅ ✅ ✅ ✅ ✅
Notifications ✅ ✅ 🔴 🔴 🔴 🔴

Documentation

Flutter Development Guide

Amplify for Flutter is an open-source project and welcomes contributions from the Flutter community, see Contributing.

Prerequisites
  • Flutter
  • Node.js v18.17 or later
  • npm v9 or later
Getting Started With Amplify Flutter
  1. 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.

  2. Run the following to create an amplify project:

    npm create amplify@latest -y

  3. To use the Authenticator, you need to add the following dependencies to your project:

    dependencies:
      amplify_auth_cognito: ^2.0.0
      amplify_authenticator: ^2.0.0
      amplify_flutter: ^2.0.0
      flutter:
        sdk: flutter
    
  4. run flutter pub get

  5. Update your main.dart file to the following:

import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:amplify_authenticator/amplify_authenticator.dart';
import 'package:amplify_flutter/amplify_flutter.dart';
import 'package:flutter/material.dart';

import 'amplify_outputs.dart';

Future<void> main() async {
  try {
    WidgetsFlutterBinding.ensureInitialized();
    await _configureAmplify();
    runApp(const MyApp());
  } on AmplifyException catch (e) {
    runApp(Text("Error configuring Amplify: ${e.message}"));
  }
}

Future<void> _configureAmplify() async {
  try {
    await Amplify.addPlugin(AmplifyAuthCognito());
    await Amplify.configure(amplifyConfig);
    safePrint('Successfully configured');
  } on Exception catch (e) {
    safePrint('Error configuring Amplify: $e');
  }
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});
  @override
  Widget build(BuildContext context) {
    return Authenticator(
      child: MaterialApp(
        builder: Authenticator.builder(),
        home: const Scaffold(
          body: Center(
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              children: [
                SignOutButton(),
                Text('TODO Application'),
              ],
            ),
          ),
        ),
      ),
    );
  }
}
  1. 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:

    npx ampx sandbox --outputs-format dart --outputs-out-dir lib

  2. 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.

  3. 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.

所属分类

依赖

依赖清单 6 项

源码仓库

使用此插件的项目