ferry_generator

Paket installieren

flutter pub add ferry_generator

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

Der Ferry Generator ist ein Codegenerierungstool für den Ferry-GraphQL-Client, das entwickelt wurde, um typensichere Dart-Klassen aus GraphQL-Operationen zu erstellen. Er vereinfacht die Arbeit mit GraphQL, indem er automatisch Modelle, Abfragen, Mutationen und Abonnements basierend auf Schema- und Abfrage-Dateien generiert. Dadurch wird Boilerplate reduziert und Laufzeitfehler minimiert, da die Typen mit der GraphQL-API übereinstimmen. Der Generator lässt sich nahtlos in Flutter-Projekte integrieren und unterstützt mehrere Plattformen wie Android, iOS, macOS, Windows und Linux.

Anwendungsfälle

GraphQL-Operations-Typen automatisch generieren
Erstellen Sie typsichere Modelle aus GraphQL-Schema
Vereinfachen Sie die Behandlung von Mutationen und Abfragen in Flutter-Apps
Aktivieren Sie die Kompilierzeitüberprüfung von GraphQL-Operationen
Unterstützung von plattformübergreifenden GraphQL-Clients

Hauptmerkmale

Generiert Dart-Klassen aus GraphQL-Dateien
Stellt Typensicherheit für GraphQL-Operationen sicher
Integriert sich mit dem Ferry-Client
Unterstützt Abfragen, Mutationen und Abonnements
Erzeugt minimalen Boilerplate-Code

Geeignet für

Flutter-Entwickler, die den Ferry-GraphQL-Client verwenden
Teams, die bei der Verwendung von GraphQL Typensicherheit priorisieren
Projekte, die eine effiziente GraphQL-Codegenerierung erfordern
Apps, die mehrere Plattformen mit gemeinsamer GraphQL-Logik ansprechen
Entwickler, die eine reduzierte manuelle Codepflege suchen

Hinweise

Erfordert ein GraphQL-Schema und Operationsdateien
Abhängig vom Ferry-Client für Laufzeitfunktionalität
Erforderliche Einrichtung in der pubspec.yaml
Kann zusätzliche Konfiguration für komplexe Schemata erfordern
Am besten in Verbindung mit der Laufzeitbibliothek von Ferry verwendet

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

A simple, powerful GraphQL Client for Flutter and Dart

Documentation 📖

Features

✅ Fully Typed: work faster and safer with compile time checks and IDE autocomplete, including fully typed Cache reads and writes.
🔄 Built-In Code Generators: automatically generated immutable data classes for all your GraphQL Operations and Fragments, based on your schema.
🌐 Customizable Network Interface: highly customizable network interface using gql_link, allowing you to compose and extend Links.
✨ Normalized Optimistic Cache: keep data in sync with cache normalization and update your UI instantly with optimistic data.
💾 Multiple Data Stores: extensible Store interface with built-in MemoryStore and HiveStore (which uses hive for offline persistence).
📄 Refetch & Pagination: easily update responses with new data or combine multiple responses, allowing for seamless pagination.
📱 Flutter Widgets: Widgets for Queries, Mutations, and Subscriptions, available out of the box.
🧈 Smooth: Run queries in a separate Isolate to free up resources on the UI thread

Packages

This repo is a monorepo for ferry and related packages.

Pub	Package	Description
	`package:ferry`	Stream-based GraphQL Client
	`package:ferry_cache`	Normalized, strongly typed, optimistic cache
	`package:ferry_exec`	Strongly typed GraphQL execution interface
	`package:ferry_flutter`	Flutter Widgets for GraphQL Operations
	`package:ferry_generator`	Dart Type Generator for GraphQL Operations
	`package:ferry_store`	Data Persistence for `ferry`'s cache
	`package:ferry_hive_store`	Hive implementation of `ferry_store`
	`package:normalize`	Normalization / denormalization of GraphQL data