The generic-aeson package

[Tags:bsd3, library]

Derivation of Aeson instances using GHC generics.


[Skip to Readme]

Properties

Versions 0.1, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.1, 0.1.1.1, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.2.0.3, 0.2.0.4, 0.2.0.5, 0.2.0.6, 0.2.0.7, 0.2.0.8
Change log CHANGELOG.md
Dependencies aeson (>=0.6 && <1.1), attoparsec (>=0.11 && <0.14), base (>=4.4 && <4.10), generic-deriving (>=1.6 && <1.12), ghc-prim, mtl (>=2.0 && <2.3), tagged (>=0.2 && <0.9), text (>=0.11 && <1.3), unordered-containers (==0.2.*), vector (>=0.10 && <0.12) [details]
License BSD3
Author Silk
Maintainer code@silk.co
Stability Unknown
Category Data
Source repository head: git clone https://github.com/silkapp/generic-aeson.git
Uploaded Mon Feb 29 20:29:03 UTC 2016 by ErikHesselink
Updated Mon Aug 22 17:29:36 UTC 2016 by AdamBergmark to revision 2
Distributions LTSHaskell:0.2.0.8, NixOS:0.2.0.8, Stackage:0.2.0.8, Tumbleweed:0.2.0.8
Downloads 4771 total (62 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2016-02-29 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for generic-aeson

Readme for generic-aeson-0.2.0.8

generic-aeson

Build Status

The structure of the generated JSON is meant to be close to idiomatic JSON. This means:

  • Enumerations (data types containing constructors without fields) are converted to JSON strings.

  • Record fields become JSON keys.

  • Data types with one unlabeled field convert to just that field.

  • Data types with multiple unlabeled fields become arrays.

  • Multiple constructors are represented by keys.

  • Maybe values are either an absent key, or the value.

  • Leading and trailing underscores are removed from constructor names and record fields

See tests/Main.hs in json-schema for more examples.

How does generic-aeson compare to the TH/Generics already present in aeson?

generic-aeson contains more special cases for creating more concise and idiomatic json. If you're working with the JSON representation directly generic-aeson should feel more natural.

Will the generated format ever change?

Changing the format would incur a breaking change to every API that uses generic-aeson so we must keep it intact.

If we find a bug where the fix changes the format we need to create a new package or version the generation code.

Schemas

json-schema has generic derivation of schemas that match the generic-aeson format.