Pakete, Repositories und App-Kategorien suchen

Paketdetailsv0.2.0

firebaseapis

Automatisch generierte Client-Bibliotheken zum Zugriff auf Google-APIs, die über den API-Entdeckungsdienst beschrieben werden.

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
20.100
Likes
21
Pub-Punkte
160

Paket installieren

flutter pub add firebaseapis

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

Das firebaseapis-Paket bietet automatisch generierte Clientbibliotheken zum Zugriff auf Google-APIs über den API-Entdeckungsdienst. Für Flutter und Dart entwickelt, ermöglicht es eine nahtlose Integration mit Firebase und anderen Google-Diensten, indem es typensichere APIs aus offiziellen API-Beschreibungen generiert. Dadurch können Entwickler direkt mit dem umfangreichen Ökosystem von Google – wie Drive, Kalender und Cloud-Speicher – in ihren Apps auf Android, iOS, Web, macOS, Windows und Linux interagieren. Das Paket wird von invertase.io gepflegt und unterstützt moderne Flutter-Entwicklungswerkzeuge.

Anwendungsfälle

  • Integration mit Google Drive
  • Zugriff auf Google Kalender-Daten
  • Abrufen von Benutzerinformationen aus Google Identity
  • Verwaltung von Cloud-Speicheroperationen
  • Daten mit Google Tabellen synchronisieren
  • Verbindung zur YouTube Data API

Hauptmerkmale

  • Automatisch aus offiziellen API-Entdeckungsdokumenten generiert
  • Typsichere Dart-Schnittstellen
  • Plattformübergreifende Unterstützung (Android, iOS, Web, macOS, Windows, Linux)
  • Nahtlose Integration mit Firebase-Projekten
  • Unterstützt OAuth2-Authentifizierungsflüsse
  • Regelmäßige Updates mit neuen Google-API-Releases

Geeignet für

  • Entwickler, die Apps erstellen, die Zugriff auf die Google-API benötigen
  • Projekte, die die Integration mit mehreren Google-Diensten erfordern
  • Plattformübergreifende Anwendungen, die auf alle wichtigen Betriebssysteme abzielen
  • Teams, die Firebase als Backend-Infrastruktur verwenden
  • Apps, die sichere, authentifizierte API-Aufrufe an Google-Dienste benötigen

Hinweise

  • Kenntnis des Google API Discovery-Formats erforderlich
  • Die Einrichtung der Authentifizierung (OAuth2) kann komplex sein
  • Große generierte Codebasen können die Build-Größe erhöhen
  • Beschränkte Dokumentation über die generierte API-Referenz hinaus
  • Nicht ideal für einfache Anwendungsfälle, bei denen leichte Clients ausreichen

Original-README

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

Firebase API Client Libraries for Dart

Chat on Discord

melos

This is based on the googleapis.dart repository but instead aimed at supporting Firebase related APIs only. Additionally, this adds support for several unlisted (but discoverable) Firebase APIs that are not listed on the official discovery API that googleapis.dart uses (and is currently limited to) as well as several private APIs (APIs that require an API key to view discovery information).

See ./generated/firebaseapis/README.md for information on all the currently supported APIs.

Usage Example

// Import the APIs you want to use
import 'package:firebaseapis/firebaseremoteconfig/v1.dart' as remote_config;
import 'package:firebaseapis/firebaserules/v1.dart' as firebase_rules;
// Import Auth client
import 'package:googleapis_auth/auth_io.dart' as auth;

// Get an Auth Client
final authClient = await auth.clientViaApplicationDefaultCredentials(scopes: [
  remote_config.FirebaseRemoteConfigApi.cloudPlatformScope,
]);

// Call some APIs
final rc = remote_config.FirebaseRemoteConfigApi(authClient);
final config =
  await rc.projects.getRemoteConfig('projects/<your-project-id>');
print(config.parameters);
print(config.parameters?.values.first.defaultValue);
print(config.parameters?.values.first.description);
print(config.parameters?.values.first.valueType);

final fr = firebase_rules.FirebaseRulesApi(authClient);
final rules =
  await fr.projects.rulesets.list('projects/<your-project-id>');
print(rules.rulesets?.first.name);
print(rules.rulesets?.first.source?.files?.first.content);

Custom Request Headers

Custom request headers can be set by adding to requestHeaders:

import 'package:firebaseapis/src/user_agent.dart';

Future<void> main() async {
  requestHeaders.addAll({
    'cool-header': 'cool-value',
  });
  print(requestHeaders);
}

Contributing

This project uses Melos to manage the project and dependencies.

To install Melos, run the following command from your SSH client:

dart pub global activate melos

Next, at the root of your locally cloned repository bootstrap the projects dependencies:

melos bootstrap

The bootstrap command locally links all dependencies within the project without having to provide manual dependency_overrides. This allows all plugins, examples and tests to build from the local clone project.

You do not need to run flutter pub get once bootstrap has been completed.

Adding a new API

To add a new API and generate library code for it is fairly straightforward;

  1. Add the API to the apis list in ./config.yaml
  2. Run melos run config:download to update the downloaded discovery document JSON files that are in ./discovery.
    • Note: several APIs require an API key to be able to read the discovery information. Set a API_KEY environment variable before running the command to be able to download the discovery documents for these private APIs, e.g. API_KEY=<your-key-here> melos run config:download.
  3. Run melos run config:generate to generate new Dart library code for the API, which outputs to ./generated/firebaseapis.

Maintained by Invertase.

Kategorien

Abhängigkeiten

Abhängigkeiten 2 Einträge

  • _discoveryapis_commons^1.0.0
  • http>=0.13.0 <2.0.0

Quell-Repository

Projekte, die dieses Paket verwenden