json_api 0.1.0 json_api: ^0.1.0 copied to clipboard
JSON:API v1.0 (http://jsonapi.org) Document, Client, and Server
Implementation of JSON:API v1.0 in Dart #
Feature roadmap
Client
- ✅ Fetching single resources and resource collections
- ✅ Fetching relationships and related resources and collections
- ✅ Fetching single resources
- ❌ Creating resources
- ❌ Updating resource's attributes
- ❌ Updating resource's relationships
- ❌ Updating relationships
- ❌ Deleting resources
- ❌ Asynchronous processing
Server (The Server API is not stable yet!)
- ✅ Fetching single resources and resource collections
- ✅ Fetching relationships and related resources and collections
- ✅ Fetching single resources
- ❌ Creating resources
- ❌ Updating resource's attributes
- ❌ Updating resource's relationships
- ❌ Updating relationships
- ❌ Deleting resources
- ❌ Inclusion of related resources
- ❌ Sparse fieldsets
- ❌ Sorting, pagination, filtering
- ❌ Asynchronous processing
Document
- ❌ Support
meta
andjsonapi
members - ❌ Structure Validation
- ❌ Naming Validation
- ❌ JSON:API v1.1 features
Usage #
In the VM:
import 'package:json_api/client.dart';
final client = JsonApiClient();
In a browser:
import 'package:json_api/client.dart';
import 'package:http/browser_client.dart';
final client = JsonApiClient(factory: () => BrowserClient());
For usage examples see a corresponding test in test/functional
.