Simple Model #

Simple way for converting to and from JSON without code generator.

Features #

• fromJson
• toJson
• copyWith

Getting started #

• SimpleModel for converting to and from JSON
• $get method for getting data by key
• $fromList method for handling list of objects
• SimpleModel.fromJsonList method for converting JSON list of objects

Usage #

If you want to convert the following JSON

{
    "name": "John Doe",
    "age": 30,
    "height": 1.8,
    "scores": [100, 90, 80],
    "isEmployed": true
}

The following example shows how to convert

import 'package:simple_model/simple_model.dart';

final class ExampleSimpleModel extends SimpleModel {
  ExampleSimpleModel.fromJson(super.data);

  String? get name => $get('name');

  int? get age => $get('age');

  double? get height => $get('height');

  List<int?>? get scores => $get('scores');

  bool? get isEmployed => $get('isEmployed');
}

Example for fromJson and toJson methods

final model = ExampleSimpleModel.fromJson({
  "name": "John Doe",
  "age": 30,
  "height": 1.8,
  "scores": [100, 90, 80],
  "isEmployed": true
});

model.name; // John Doe

model.age; // 30

model.height; // 1.8

model.scores; // [100, 90, 80]

model.isEmployed; // true

model.toJson();

Advanced JSON format #

If you want to convert JSON data like this

{
  ...
  "company": {
    "name": "Google",
    "location": "Mountain View"
  },
  "friends": [
    {"name": "Jane Doe", "age": 28},
    {"name": "Jack Doe", "age": 32}
  ]
}

The following example shows how to convert

final class ExampleSimpleModel extends SimpleModel {
  ...

  ExampleCompanySimpleModel? get company => $get(
        'company',
        fromJson: ExampleCompanySimpleModel.fromJson,
      );

  List<ExampleFriendSimpleModel?>? get friends => $get(
        'friends',
        fromList: $fromList(ExampleFriendSimpleModel.fromJson),
      );
}

final class ExampleCompanySimpleModel extends SimpleModel {
  ExampleCompanySimpleModel.fromJson(super.data);

  String? get name => $get('name');

  String? get location => $get('location');
}

final class ExampleFriendSimpleModel extends SimpleModel {
  ExampleFriendSimpleModel.fromJson(super.data);

  String? get name => $get('name');

  int? get age => $get('age');
}

If you want to convert the JSON like this

[
  {
    "name": "John Doe",
    "age": 30,
    "height": 1.8,
    "scores": [100, 90, 80],
    "isEmployed": true
  },
  {
    "name": "Kevin Doe",
    "age": 35,
    "height": 2.8,
    "scores": [100, 90, 80, 70],
    "isEmployed": false
  }
]

The following example shows how to convert

final model = SimpleModel.fromJsonList(ExampleSimpleModel.fromJson)([
  {
    "name": "John Doe",
    "age": 30,
    "height": 1.8,
    "scores": [100, 90, 80],
    "isEmployed": true
  },
  {
    "name": "Kevin Doe",
    "age": 35,
    "height": 2.8,
    "scores": [100, 90, 80, 70],
    "isEmployed": false
  }
]);

model.length; // 2

Copy with #

You can add copyWith like this

ExampleSimpleModel copyWith({
  String? name,
  int? age,
  double? height,
  List<int?>? scores,
  bool? isEmployed,
  ExampleCompanySimpleModel? company,
  List<ExampleFriendSimpleModel?>? friends,
}) =>
    $copyWith(
      toJson(),
      fromJson: ExampleSimpleModel.fromJson,
      value: {
        'name': name,
        'age': age,
        'height': height,
        'scores': scores,
        'isEmployed': isEmployed,
        'company': company?.toJson(),
        'friends': friends?.toJson(),
      },
    );