패키지, 저장소 및 앱 카테고리 검색

패키지 상세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 개

소스 저장소

이 패키지를 사용하는 프로젝트