generic-aeson: Derivation of Aeson instances using GHC generics.
Modules
[Index]
Downloads
- generic-aeson-0.2.0.3.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 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, 0.2.0.9, 0.2.0.10, 0.2.0.11, 0.2.0.12, 0.2.0.13, 0.2.0.14 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=0.6 && <0.9), attoparsec (>=0.11 && <0.13), base (>=4.6 && <4.9), generic-deriving (>=1.6 && <1.8), mtl (>=2.0 && <2.3), tagged (>=0.2 && <0.9), text (>=0.11 && <1.3), unordered-containers (>=0.2 && <0.3), vector (>=0.10 && <0.11) [details] |
| License | BSD-3-Clause |
| Author | Silk |
| Maintainer | code@silk.co |
| Revised | Revision 1 made by AdamBergmark at 2015-04-03T14:42:39Z |
| Category | Data |
| Source repo | head: git clone https://github.com/silkapp/generic-aeson.git |
| Uploaded | by AdamBergmark at 2015-04-03T00:16:30Z |
| Distributions | |
| Reverse Dependencies | 7 direct, 6 indirect [details] |
| Downloads | 21305 total (88 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2015-04-03 [all 1 reports] |
Readme for generic-aeson-0.2.0.3
[back to package description]generic-aeson
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.
-
Maybevalues 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.