json_api_document 0.0.5

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 59

JSON API Document model

Work in progress

The goal of this library is to provide a transparent way to build JSON API Documents.

  • A JSON API Document is an immutable value object which can be converted to JSON using JSON.encode()
  • All JSON API Documents are guaranteed to comply with JSON API v1.0

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

Use this package as a library

1. Depend on it

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


dependencies:
  json_api_document: "^0.0.5"

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 flutter 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_api_document/json_api_document.dart';
  
Version Uploaded Documentation Archive
0.0.5 Mar 12, 2018 Go to the documentation of json_api_document 0.0.5 Download json_api_document 0.0.5 archive
0.0.4 Mar 12, 2018 Go to the documentation of json_api_document 0.0.4 Download json_api_document 0.0.4 archive
0.0.3 Mar 10, 2018 Go to the documentation of json_api_document 0.0.3 Download json_api_document 0.0.3 archive
0.0.2 Mar 8, 2018 Go to the documentation of json_api_document 0.0.2 Download json_api_document 0.0.2 archive
0.0.1 Mar 7, 2018 Go to the documentation of json_api_document 0.0.1 Download json_api_document 0.0.1 archive

Analysis

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

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

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

Platforms

Detected platforms: Flutter, web, other

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

Suggestions

  • 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_api_document.dart.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

    Run dartfmt to format lib/src/document.dart.

Dependencies

Package Constraint Resolved Available
Dev dependencies
json_matcher ^0.1.0
test ^0.12.32