dart_data_rest 0.1.1 copy "dart_data_rest: ^0.1.1" to clipboard
dart_data_rest: ^0.1.1 copied to clipboard

REST backend adapter for dart_data. Connects your offline-first local database to any REST API with push, pull, pagination, and authentication.

dart_data_rest #

pub package CI License: BSD-3

REST backend adapter for dart_data — the SwiftData for Flutter.

Connect your offline-first local database to any REST API. Handles push, pull, pagination, and authentication out of the box.

Installation #

dependencies:
  dart_data: ^0.1.0
  dart_data_rest: ^0.1.0

Usage #

import 'package:dart_data/dart_data.dart';
import 'package:dart_data_rest/dart_data_rest.dart';

final adapter = RestAdapter();
await adapter.initialize(BackendConfig(
  url: 'https://api.example.com',
  headers: {'Authorization': 'Bearer token'},
));

final syncEngine = SyncEngine(
  adapter: adapter,
  queue: OperationQueue(storage: sqliteStorage),
  statusNotifier: SyncStatusNotifier(),
  modelTypes: ['Todo'],
);

await syncEngine.sync();

How It Works #

The REST adapter maps dart_data sync operations to standard HTTP verbs:

Operation HTTP Method Endpoint
Create POST /todos
Update PATCH /todos/:id
Delete DELETE /todos/:id
Pull GET /todos?since=<timestamp>

Endpoint mapping and response parsing are configurable.

Learn More #

See the dart_data documentation for full framework docs.

License #

BSD 3-Clause. See LICENSE.

0
likes
130
points
67
downloads

Publisher

unverified uploader

Weekly Downloads

REST backend adapter for dart_data. Connects your offline-first local database to any REST API with push, pull, pagination, and authentication.

Topics

#rest #sync #offline-first #http #database

Documentation

API reference

License

BSD-3-Clause (license)

Dependencies

dart_data, http

More

Packages that depend on dart_data_rest