Package selection guidance compiled from public package information, community data, and project usage.
japx is a lightweight Flutter/Dart package designed to parse and work with JSON:API structured data. It simplifies the process of handling responses from servers that follow the JSON:API specification, enabling developers to efficiently extract and manage resources, relationships, and metadata. The package is optimized for performance and ease of use, making it ideal for apps integrating with JSON:API-compliant backends. With minimal overhead, japx supports all major platforms including Android, iOS, Web, macOS, Windows, and Linux.
Use cases
Parsing JSON:API responses
Handling nested relationships
Extracting metadata from API payloads
Building apps with JSON:API backends
Simplifying API data modeling
Key features
Lightweight and fast
Supports full JSON:API structure
Cross-platform compatibility
Easy-to-use parsing interface
Minimal boilerplate
Suitable for
Flutter apps using JSON:API
Developers needing efficient API parsing
Projects requiring clean data transformation
Teams working with REST APIs following JSON:API spec
Apps targeting multiple platforms
Considerations
Requires adherence to JSON:API format
Limited to JSON:API-specific use cases
No built-in caching or network layer
Not suitable for non-JSON:API data structures
Dependent on server-side JSON:API compliance
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
Flutter Japx - JSON:API Decoder/Encoder
Lightweight [JSON:API][1] parser that flattens complex [JSON:API][1] structure and turns it into simple JSON and vice versa.
It works by transferring Map<String, dynamic> to Map<String, dynamic>, so you can use json_serializable or any other object mapping tool that you prefer.
For decoding the API responses use function Japx.decode(Map<String, dynamic> jsonApi, {String includeList}) which returns flattened JSON.
Include list is an optional parameter and it is used for deserializing JSON:API relationships.
For encoding use function Japx.encode(Object json, {Map<String, dynamic> additionalParams}) which will return a JSON with JSON:API format.
{"data":[{"type":"articles","id":"1","attributes":{"title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"},"relationships":{"author":{"data":{"id":"42","type":"people"}}}}],"included":[{"type":"people","id":"42","attributes":{"name":"John","age":80,"gender":"male"}}]}
Parsed JSON:
{"data":[{"type":"articles","id":"1","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z","author":{"type":"people","id":"42","name":"John","age":80,"gender":"male"}}]}
Decoding additional info
Response:
{"data":[{"type":"articles","id":"3","attributes":{"title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"}}],"meta":{"total-pages":13},"links":{"self":"http://example.com/articles?page[number]=3&page[size]=1","first":"http://example.com/articles?page[number]=1&page[size]=1","prev":"http://example.com/articles?page[number]=2&page[size]=1","next":"http://example.com/articles?page[number]=4&page[size]=1","last":"http://example.com/articles?page[number]=13&page[size]=1"},"additional":{"info":"My custom info"}}
Parsed JSON:
{"data":[{"type":"articles","id":"3","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"}],"meta":{"total-pages":13},"links":{"self":"http://example.com/articles?page[number]=3&page[size]=1","first":"http://example.com/articles?page[number]=1&page[size]=1","prev":"http://example.com/articles?page[number]=2&page[size]=1","next":"http://example.com/articles?page[number]=4&page[size]=1","last":"http://example.com/articles?page[number]=13&page[size]=1"},"additional":{"info":"My custom info"}}
{"type":"articles","id":"1","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z","author":{"type":"people","id":"42","name":"John","age":80,"gender":"male","article":{"type":"articles","id":"1","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z","author":{"type":"people","id":"42","name":"John","age":80,"gender":"male"}}}}
Encode result:
{"data":{"type":"articles","id":"1","attributes":{"title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"},"relationships":{"author":{"data":{"id":"42","type":"people"}}}}}
Simple project with mocked API can be found in this repository. Clone the repository, set the main.dart as an application starting point and run the project.
Usage with JsonSerializable
This package can be implemented as a simple layer into your exisiting stack. For example, if you use JsonSerializable, you can do it like this:
We believe that the community can help us improve and build better a product.
Please refer to our contributing guide to learn about the types of contributions we accept and the process for submitting them.
To ensure that our community remains respectful and professional, we defined a code of conduct that we expect all contributors to follow.
We appreciate your interest and look forward to your contributions.
License
Copyright 2024 Infinum
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.