Safe Haskell | None |
---|---|
Language | Haskell2010 |
This module provides a way to specify the shape of your JSON data at the type level.
Example
data User = User { name :: Text , lastLogin :: UTCTime } deriving stock (Show, Eq) deriving (ToJSON, FromJSON) via (SpecJSON User) instance HasJsonEncodingSpec User where type EncodingSpec User = JsonObject '[ Required "name" JsonString, Required "last-login" JsonDateTime ] toJSONStructure user = (Field @"name" (name user), (Field @"last-login" (lastLogin user), ())) instance HasJsonDecodingSpec User where type DecodingSpec User = EncodingSpec User fromJSONStructure (Field @"name" name, (Field @"last-login" lastLogin, ())) = pure User { name , lastLogin }
Motivation
The primary motivation is to allow you to avoid Aeson Generic instances while still getting the possibility of auto-generated (and therefore correct) documentation and code in your servant APIs.
Historically, the trade-off has been:
- Use Generic instances, and therefore your API is brittle. Changes to Deeply nested object might unexpectedly change (and break) your API. You must structure your Haskell types exactly as they are rendered into JSON, which may not always be "natural" and easy to work with. In exchange, you get the ability to auto-derive matching ToSchema instances along with various code generation tools that all understand Aeson Generic instances.
- Hand-write your ToJSON and FromJSON instances, which means you get to structure your Haskell types in the way that works best for Haskell, while structuring your JSON in the way that works best for your API. It also means you can more easily support "old" decoding versions and more easily maintain backwards compatibility, etc. In exchange, you have to to hand-write your ToSchema instances, and code generation is basically out.
The goal of this library is to provide a way to hand-write the encoding
and decoding of your JSON using type-level Specification
s, while
still allowing the use of tools that can interpret the specification
and auto-generate ToSchema instances and code.
The tooling ecosystem that knows how to interpret Specification
s
is still pretty new, but it at least includes OpenApi compatibility
(i.e. ToSchema instances) and Elm code generation.
Synopsis
- data Specification
- class HasJsonEncodingSpec a where
- type EncodingSpec a :: Specification
- toJSONStructure :: a -> JSONStructure (EncodingSpec a)
- class HasJsonDecodingSpec a where
- type DecodingSpec a :: Specification
- fromJSONStructure :: JSONStructure (DecodingSpec a) -> Parser a
- newtype SpecJSON a = SpecJSON {
- unSpecJson :: a
- data Tag (a :: Symbol) = Tag
- newtype Field (key :: Symbol) t = Field {
- unField :: t
- type family JSONStructure (spec :: Specification) where ...
- newtype Rec (env :: [(Symbol, Type)]) (name :: Symbol) (spec :: Specification) = Rec {}
- eitherDecode :: forall (spec :: Specification). StructureFromJSON (JSONStructure spec) => Proxy spec -> Value -> Either String (JSONStructure spec)
- class StructureFromJSON a
- data FieldSpec
Documentation
data Specification Source #
Simple DSL for defining type level "specifications" for JSON data. Similar in spirit to (but not isomorphic with) JSON Schema.
Intended to be used at the type level using -XDataKinds
See JSONStructure
for how these map into Haskell representations.
JsonObject [FieldSpec] | An object with the specified properties, each having its own
specification. This does not yet support optional properties,
although a property can be specified as "nullable" using
|
JsonString | An arbitrary JSON string. |
JsonNum | An arbitrary (floating point) JSON number. |
JsonInt | A JSON integer. |
JsonArray Specification | A JSON array of values which conform to the given spec. |
JsonBool | A JSON boolean value. |
JsonNullable Specification | A value that can either be E.g.: type SpecWithNullableField = JsonObject '[ Required "nullableProperty" (JsonNullable JsonString) ] |
JsonEither Specification Specification | One of two different specifications. Corresponds to json-schema "oneOf". Useful for encoding sum types. E.g: data MyType = Foo Text | Bar Int | Baz UTCTime instance HasJsonEncodingSpec MyType where type EncodingSpec MyType = JsonEither ( JsonObject '[ Required "tag" (JsonTag "foo"), Required "content" JsonString ] ) ( JsonEither ( JsonObject '[ Required "tag" (JsonTag "bar"), Required "content" JsonInt ] ) ( JsonObject '[ Required "tag" (JsonTag "baz"), Required "content" JsonDateTime ] ) ) |
JsonTag Symbol | A constant string value |
JsonDateTime | A JSON string formatted as an ISO-8601 string. In Haskell this
corresponds to |
JsonLet [(Symbol, Specification)] Specification | A "let" expression. This is useful for giving names to types, which can then be used in the generated code. This is also useful to shorten repetitive type definitions. For example, this repetitive definition: type Triangle = JsonObject '[ Required "vertex1" (JsonObject '[ Required "x" JsonInt, Required "y" JsonInt, Required "z" JsonInt ]), Required "vertex2" (JsonObject '[ Required "x" JsonInt, Required "y" JsonInt, Required "z" JsonInt ]), Required "vertex3" (JsonObject '[ Required "x" JsonInt), Required "y" JsonInt), Required "z" JsonInt) ]) ] Can be written more concisely as: type Triangle = JsonLet '[ '("Vertex", JsonObject '[ ('x', JsonInt), ('y', JsonInt), ('z', JsonInt) ]) ] (JsonObject '[ Required "vertex1" JsonRef "Vertex", Required "vertex2" JsonRef "Vertex", Required "vertex3" JsonRef "Vertex" ]) Another use is to define recursive types: type LabelledTree = JsonLet '[ '("LabelledTree", JsonObject '[ Required "label", JsonString, Required "children" (JsonArray (JsonRef "LabelledTree")) ]) ] (JsonRef "LabelledTree") |
JsonRef Symbol | A reference to a specification which has been defined in a surrounding
|
class HasJsonEncodingSpec a where Source #
Types of this class can be encoded to JSON according to a type-level
Specification
.
type EncodingSpec a :: Specification Source #
The encoding specification.
toJSONStructure :: a -> JSONStructure (EncodingSpec a) Source #
Encode the value into the structure appropriate for the specification.
Instances
HasJsonEncodingSpec a => HasJsonEncodingSpec (Set a) Source # | |||||
Defined in Data.JsonSpec.Encode
toJSONStructure :: Set a -> JSONStructure (EncodingSpec (Set a)) Source # |
class HasJsonDecodingSpec a where Source #
Types of this class can be JSON decoded according to a type-level
Specification
.
type DecodingSpec a :: Specification Source #
The decoding Specification
.
fromJSONStructure :: JSONStructure (DecodingSpec a) -> Parser a Source #
Given the structural encoding of the JSON data, parse the structure
into the final type. The reason this returns a
instead of
just a plain Parser
aa
is because there may still be some invariants of the
JSON data that the Specification
language is not able to express,
and so you may need to fail parsing in those cases. For instance,
Specification
is not powerful enough to express "this field must
contain only prime numbers".
Helper for defining ToJSON
and FromJSON
instances based on
HasEncodingJsonSpec
.
Use with -XDerivingVia like:
data MyObj = MyObj { foo :: Int , bar :: Text } deriving (ToJSON, FromJSON) via (SpecJSON MyObj) instance HasEncodingSpec MyObj where ... instance HasDecodingSpec MyObj where ...
SpecJSON | |
|
Instances
(StructureFromJSON (JSONStructure (DecodingSpec a)), HasJsonDecodingSpec a) => FromJSON (SpecJSON a) Source # | |
Defined in Data.JsonSpec | |
(StructureToJSON (JSONStructure (EncodingSpec a)), HasJsonEncodingSpec a) => ToJSON (SpecJSON a) Source # | |
data Tag (a :: Symbol) Source #
Structural representation of JsonTag
. (I.e. a constant string value.)
Instances
KnownSymbol const => StructureFromJSON (Tag const) Source # | |
Defined in Data.JsonSpec.Decode reprParseJSON :: Value -> Parser (Tag const) |
newtype Field (key :: Symbol) t Source #
Structural representation of an object field.
Instances
Show t => Show (Field key t) Source # | |
Eq t => Eq (Field key t) Source # | |
(KnownSymbol key, StructureFromJSON val, StructureFromJSON more) => StructureFromJSON (Field key val, more) Source # | |
Defined in Data.JsonSpec.Decode reprParseJSON :: Value -> Parser (Field key val, more) | |
(KnownSymbol key, StructureFromJSON val, StructureFromJSON more) => StructureFromJSON (Maybe (Field key val), more) Source # | |
Defined in Data.JsonSpec.Decode reprParseJSON :: Value -> Parser (Maybe (Field key val), more) |
type family JSONStructure (spec :: Specification) where ... Source #
is the Haskell type used to contain the JSON data
that will be encoded or decoded according to the provided JSONStructure
specspec
.
Basically, we represent JSON objects as "list-like" nested tuples of the form:
(Field @key1 valueType, (Field @key2 valueType, (Field @key3 valueType, ())))
Arrays, booleans, numbers, and strings are just Lists, Bool
s,
Scientific
s, and Text
s respectively.
If the user can convert their normal business logic type to/from this
tuple type, then they get a JSON encoding to/from their type that is
guaranteed to be compliant with the Specification
JSONStructure spec = JStruct ('[] :: [(Symbol, Type)]) spec |
newtype Rec (env :: [(Symbol, Type)]) (name :: Symbol) (spec :: Specification) Source #
This allows for recursive specifications.
Since the specification is at the type level, and type level haskell is strict, specifying a recursive definition the "naive" way would cause an infinitely sized type.
For example this won't work:
data Foo = Foo [Foo] instance HasJsonEncodingSpec Foo where type EncodingSpec Foo = JsonArray (EncodingSpec Foo) toJSONStructure = ... can't be written
Using JsonLet
prevents the specification type from being infinitely
sized, but what about "structure" type which holds real values
corresponding to the spec? The structure type has to have some way to
reference itself or else it too would be infinitely sized.
In order to "reference itself" the structure type has to go through a newtype somewhere along the way, and that's what this type is for. Whenever the structure type for your spec requires a self-reference, it will require you to wrap the recursed upon values in this type.
For example:
data Foo = Foo [Foo] instance HasJsonEncodingSpec Foo where type EncodingSpec Foo = JsonLet '[ '("Foo", JsonArray (JsonRef "Foo")) ] (JsonRef "Foo") toJSONStructure (Foo fs) = [ Rec (toJSONStructure f) | f <- fs ]
Instances
StructureFromJSON (JStruct ('(name, Rec env name spec) ': env) spec) => StructureFromJSON (Rec env name spec) Source # | |
Defined in Data.JsonSpec.Decode reprParseJSON :: Value -> Parser (Rec env name spec) |
eitherDecode :: forall (spec :: Specification). StructureFromJSON (JSONStructure spec) => Proxy spec -> Value -> Either String (JSONStructure spec) Source #
Directly decode some JSON accoring to a spec without going through any To/FromJSON instances.
class StructureFromJSON a Source #
Analog of FromJSON
, but specialized for decoding our
"json representations", and closed to the user because the haskell
representation scheme is fixed and not extensible by the user.
We can't just use FromJSON
because the types we are using
to represent "json data" (i.e. the JSONStructure
type family) already
have ToJSON
instances. Even if we were to make a bunch of newtypes
or whatever to act as the json representation (and therefor also force
the user to do a lot of wrapping and unwrapping), that still wouldn't
be sufficient because someone could always write an overlapping (or
incoherent) ToJSON
instance of our newtype! This way we don't have
to worry about any of that, and the types that the user must deal with
when implementing fromJSONRepr
can be simple tuples and such.
reprParseJSON
Instances
Specify a field in an object.
Required Symbol Specification | The field is required |
Optional Symbol Specification | The field is optionsl |