json_annotation 0.2.3

  • README.md
  • Installing
  • Versions
  • 98

Defines the annotations used by json_serializable to create code for JSON serialization and deserialization.

See the example to understand how to configure your package.

Features and bugs

Please file feature requests and bugs at the issue tracker.


  • Added ignore field to JsonKey class annotation


  • Added a helper class – $JsonMapWrapper – and helper functions – $wrapMap, $wrapMapHandleNull, $wrapList, and $wrapListHandleNull – to support the useWrappers option added to JsonSerializableGenerator in v0.3.0 of package:json_serializable.


  • JsonSerializable class annotation
    • Added nullable field.
    • Fixed doc comment.


  • Moved annotation classes for JsonSerializable and JsonLiteral.

1. Depend on it

Add this to your package's pubspec.yaml file:

  json_annotation: "^0.2.3"

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter packages get

Alternatively, your editor might support pub get or packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:json_annotation/json_annotation.dart';
Version Uploaded Documentation Archive
0.2.3 Apr 3, 2018 Go to the documentation of json_annotation 0.2.3 Download json_annotation 0.2.3 archive
0.2.2 Dec 15, 2017 Go to the documentation of json_annotation 0.2.2 Download json_annotation 0.2.2 archive
0.2.1 Nov 2, 2017 Go to the documentation of json_annotation 0.2.1 Download json_annotation 0.2.1 archive
0.2.0 Sep 27, 2017 Go to the documentation of json_annotation 0.2.0 Download json_annotation 0.2.0 archive


We analyzed this package on Apr 23, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6


Describes how popular the package is relative to other packages. [more]
96 / 100
Code health derived from static analysis. [more]
100 / 100
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
Learn more about scoring.


Detected platforms: Flutter, web, other

No platform restriction found in primary library package:json_annotation/json_annotation.dart.


  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use json_annotation.dart.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.24.0 <2.0.0