Json_serializable.dart: support for nested items in @JsonKey(name:)

[KorbinianMossandl]

It would be great if we could directly access nested items in the name String of @JsonKey. Consider this Json:

"root_item": {
    "items": [
        {
            "name": "first nested item"
        },
        {
            "name": "second nested item"
        }
    ]
}

I would like to do:

@JsonKey(name: "root_item/items")
List<NestedItem> nestedItems;

Sorry if this is already possible, but i could not find anything.

[kevmoo]

Interesting idea. It is currently not supported.

[vanlooverenkoen]

This should really be added. Now we have to create extra objects because we had to use a crappy backend. Using a simple api to flatten your backend models

[huanxsd]

I really need this feature. Is it supported now?

[vanlooverenkoen]

Is there a roadmap for this feature? What timeframe could we expect for a P2?

[k-paxian]

If you guys are still waiting for that feature, this library already has it implemented
https://github.com/k-paxian/dart-json-mapper#nesting-configuration

@KorbinianMossandl thank you for a great idea! This thing is called rfc6901

[vanlooverenkoen]

Thanks. but I need to use json_serializable. Because I am using retrofit.dart that uses toJson and fromJson.

[kevmoo]

PRs welcome here!

[NicolaVerbeeck]

I am working on an implementation for this.
Rough draft can be found here: https://github.com/Chimerapps/json_serializable/tree/feature/json_path

WIP, not ready for production

[mokai]

Necessary function !

[taoyimin]

I really need this feature!

[masewo]

I forked @NicolaChimerapps fork and corrected two small errors:
https://github.com/masewo/json_serializable/tree/feature/json_path
For now it is working for me.

[kevmoo]

@masewo and @NicolaChimerapps – I'll happily take a solid PR with testing, etc

[ouyanghuacom]

It's wishful for me.

[jeffaknine]

Any update on this ?

[miguelpruivo]

Bumping as this is a must have.

[kevmoo]

Pull requests welcome – beyond the core features offered now, this package is a "beyond work hours" project.

[hacker1024]

If #783 gets merged, this will be possible, albeit in a convoluted manner:

@JsonSerializable()
class MyObject {
  @JsonKey(name: 'myRegularField')
  final String myRegularField;

  @JsonKey(extra: true)
  final String myNestedField;

  MyObject({
    required this.myRegularField,
    required this.myNestedField,
  });

  factory MyObject.fromJson(Map<String, dynamic> json) {
    return _$MyObjectFromJson(
      json,
      myNestedField: json['myInnerObject']['myNestedField'] as String,
    );
  }

  Map<String, dynamic> toJson() {
    final output = _$MyObjectToJson(this);
    output['myInnerObject'] = {'myNestedField': myNestedField};
    return output;
  }
}