https://github.com/artem-galas/dart_jsona
Data formatter that creates simplified objects from JSON, creates JSON from the same simplified objects (in according with JSON API specification)
https://github.com/artem-galas/dart_jsona
dart deserialize jsonapi serialization
Last synced: 3 months ago
JSON representation
Data formatter that creates simplified objects from JSON, creates JSON from the same simplified objects (in according with JSON API specification)
- Host: GitHub
- URL: https://github.com/artem-galas/dart_jsona
- Owner: artem-galas
- License: mit
- Created: 2018-10-16T17:24:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-13T19:48:39.000Z (almost 7 years ago)
- Last Synced: 2025-10-23T00:57:13.969Z (3 months ago)
- Topics: dart, deserialize, jsonapi, serialization
- Language: Dart
- Homepage: https://pub.dartlang.org/packages/dart_jsona
- Size: 36.1 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dart_jsona
[](https://pub.dartlang.org/packages/dart_jsona)
[](https://travis-ci.org/artem-galas/dart_jsona)
It's a ported to dart - [Jsona TS](https://github.com/olosegres/jsona)
Framework agnostic, customizable library that provide data formatters to simplify work with JSON API v1.0 specification.
This package don't have any dependencies and pretty simple. It used `Map` a lot 😑
It was designed to work with [json_serializable](https://pub.dartlang.org/packages/json_serializable)
## Install
In your `pubspec.yaml`
```
dependencies:
dart_jsona: ^0.0.1
```
## Usage
### Deserializer - creates simplified object(s) from json
```
import 'package:dart_jsona/dart_jsona.dart';
main() {
Jsona jsona = new Jsona();
final body = {
'data': {
'type': 'town',
'id': '123',
'attributes': {
'name': 'Barcelona',
},
'relationships': {
'country': {
'data': {
'type': 'country',
'id': '32',
}
}
}
},
'included': [{
'type': 'country',
'id': '32',
'attributes': {
'name': 'Spain',
}
}]
};
final town = jsona.deserialize(body);
print(town);
/**
{
type: town,
id: 123,
name: Barcelona,
country: {
type: country,
id: 32, name: Spain
},
relationshipNames: [country]
}
*/
}
```
### Serializer - creates json from simplified object(s)
```
import 'package:dart_jsona/dart_jsona.dart';
main() {
Jsona jsona = new Jsona();
Map newJson = jsona.serialize(stuff: town, includedNames: ['country']);
print(newJson);
/**
{
data: {
id: 123,
type: town,
attributes: {
name: Barcelona
},
relationships: {
country: {
data: {
id: 32, type: country
}
}
}
},
included: [{
id: 32,
type: country,
attributes: {
name: Spain
}
}]
}
*/
}
```
### Deserialize example from https://jsonapi.org/
```
var jsonApi = {
"links": {
"self": "http://example.com/articles",
"next": "http://example.com/articles?page[offset]=2",
"last": "http://example.com/articles?page[offset]=10"
},
"data": [{
"type": "articles",
"id": "1",
"attributes": {
"title": "JSON API paints my bikeshed!"
},
"relationships": {
"author": {
"links": {
"self": "http://example.com/articles/1/relationships/author",
"related": "http://example.com/articles/1/author"
},
"data": { "type": "people", "id": "9" }
},
"comments": {
"links": {
"self": "http://example.com/articles/1/relationships/comments",
"related": "http://example.com/articles/1/comments"
},
"data": [
{ "type": "comments", "id": "5" },
{ "type": "comments", "id": "12" }
]
}
},
"links": {
"self": "http://example.com/articles/1"
}
}],
"included": [{
"type": "people",
"id": "9",
"attributes": {
"firstName": "Dan",
"lastName": "Gebhardt",
"twitter": "dgeb"
},
"links": {
"self": "http://example.com/people/9"
}
}, {
"type": "comments",
"id": "5",
"attributes": {
"body": "First!"
},
"relationships": {
"author": {
"data": { "type": "people", "id": "2" }
}
},
"links": {
"self": "http://example.com/comments/5"
}
}, {
"type": "comments",
"id": "12",
"attributes": {
"body": "I like XML better"
},
"relationships": {
"author": {
"data": { "type": "people", "id": "9" }
}
},
"links": {
"self": "http://example.com/comments/12"
}
}]
};
var jsonApiModel = jsona.deserialize(jsonApi);
print(jsonApiModel);
/**
[
{
type: 'articles',
id: 1,
title: 'JSON API paints my bikeshed!',
links: {
self: 'http://example.com/articles/1'
},
author: {
type: 'people',
id: 9,
firstName: 'Dan',
lastName: 'Gebhardt',
twitter: 'dgeb',
links: {
self: 'http://example.com/people/9'
}
},
comments: [{
type: 'comments',
id: 5,
body: 'First!',
links: {
self: 'http://example.com/comments/5'
},
author: {
type: 'people',
id: 2
},
relationshipNames: [author]
},
{
type: 'comments',
id: 12,
body: 'I like XML better',
links: {
self: 'http://example.com/comments/12'
},
author: {
type: 'people',
id: 9,
firstName: 'Dan',
lastName: 'Gebhardt',
twitter: 'dgeb',
links: {
self: 'http://example.com/people/9'
}
},
relationshipNames: [author]
}],
relationshipNames: [author, comments]
}
];
*/
```
### Deserialize in angular service + `dart:convert` + [json_serializable](https://pub.dartlang.org/packages/json_serializable)
```
// post_service.dart
import 'dart:async';
import 'dart:convert';
import 'package:http/http.dart';
import 'package:dart_jsona/dart_jsona.dart';
class PostService {
static final _postUrl = 'api/posts';
final Client _http;
PostService(this._http);
Future> getPosts() async {
try {
final response = await _http.get('${apiUrl}/${_postUrl}');
// create a new post from json
final posts = (_extractData(response) as List)
.map((value) => PostModel.fromJson(value))
.toList();
return posts;
} catch(e) {
throw _handleError(e);
}
}
dynamic _extractData(Response resp) {
// initialze Jsona
Jsona jsona = new Jsona();
// convert to `Map` from `String`
var response = json.decode(resp.body)
// deserialize response body
return jsona.deserialize(response);
}
Exception _handleError(dynamic e) {
return Exception('Server error; cause: $e');
}
}
```
```
// post_model.dart
import 'package:json_annotation/json_annotation.dart';
part 'post_model.g.dart';
@JsonSerializable()
class PostModel {
final String body;
final String image;
PostModel(this.body, this.image);
factory PostModel.fromJson(Map json) => _$PostModelFromJson(json);
Map toJson() => _$PostModelToJson(this);
}
```
### Serializer in angular service + + `dart:convert` + [json_serializable](https://pub.dartlang.org/packages/json_serializable)
```
Furute createPost(PostModel data) async {
try {
final response = await _http.post('${apiUrl}/posts', body: _decodeRequest(data));
return PostModel.fromJson(_extractData(response));
} catch(e) {
throw _handleError(e);
}
}
dynamic _decodeRequest(dynamic body) {
// initialize Jsona
Jsona jsona = new Jsona();
body = body.toJson();
// add type property
body['type'] = 'post';
// serialize body
return json.encode(jsona.serialize(stuff: body));
}
```
## Contributing
Contributing are welcome.
This package on an early stage, and I'll be happy if you fix or create a new feature.
You just need follow these steps:
- Fork the repo
- Make new branch
- Write code magic
- Write tests
- Create PR
## License
Jsona, examples provided in this repository and in the documentation are [MIT licensed](./LICENSE).