aeson-injector

Injecting fields into aeson values

Version on this page:1.1.0.0
LTS Haskell 11.22:1.1.0.0
Stackage Nightly 2018-03-12:1.1.0.0
Latest on Hackage:2.0.0.0

See all snapshots aeson-injector appears in

MIT licensed by Anton Gushcha
Maintained by [email protected]
This version can be pinned in stack with:aeson-injector-1.1.0.0@sha256:538b2c53e5f19c70155a0466fa8eb264c8c19a14ded8f8a121293ca64b310473,1678

Module documentation for 1.1.0.0

aeson-injector

Build Status

It is small utility library that is intented to be used in RESTful APIs, especially with servant and Swagger. Its main purpose is simple injection of fields into JSONs produced by aeson library.

Consider the following common data type in web service developing:

data News = News {
  title :: Text
, body :: Text
, author :: Text
, timestamp :: UTCTime  
}

-- Consider we have simple 'ToJSON' and 'FromJSON' instances
$(deriveJSON defaultOptions ''News) 

ToJSON instance produces JSON’s like:

{
  "title": "Awesome piece of news!"
, "body": "Big chunk of text"
, "author": "Just Me"
, "timestamp": "2016-07-26T18:54:42.678999Z"
}

Now one can create a simple web server with servant DSL:

type NewsId = Word 

type NewsAPI = 
       ReqBody '[JSON] News :> Post '[JSON] NewsId
  :<|> Capture "news-id" NewsId :> Get '[JSON] News
  :<|> "list" :> Get '[JSON] [News]

All seems legit, but, wait a second, an API user definitely would like to know id of news in list method. One way to do this is declare new type NewsInfo with additional field, but it is bad solution as requires to keep extra data type for each resource.

So, here aeson-injector steps in, now you can write:

type NewsAPI = 
       ReqBody '[JSON] News :> Post '[JSON] NewsId
  :<|> Capture "news-id" NewsId :> Get '[JSON] News
  :<|> "list" :> Get '[JSON] [WithField "id" NewsId News]

WithField "id" NewsId News or simply WithId NewsId News wraps you data type and injects id field in produced JSON values:

>>> encode (WithField 42 myNews :: WithField "id" NewsId News)
{
  "id": 42
, "title": "Awesome piece of news!"
, "body": "Big chunk of text"
, "author": "Just Me"
, "timestamp": "2016-07-26T18:54:42.678999Z"
}

WithField data type has FromJSON instance for seamless parsing of data with injected fields and ToSchema instance for servant-swagger support.

Injecting multiple values

The library also has more general data type WithFields a b that injects fields of ‘toJSON a’ into toJSON b.

data NewsPatch = NewsPatch {
  taggs :: [Text]
, rating :: Double
}
$(deriveJSON defaultOptions ''NewsPatch) 
let myNewsPatch = NewsPatch ["tag1", "tag2"] 42 
in encode $ WithFields myNewsPatch myNews
{
  "title": "Awesome piece of news!"
, "body": "Big chunk of text"
, "author": "Just Me"
, "timestamp": "2016-07-26T18:54:42.678999Z"
, "tags": ["tag1", "tag2"]
, "rating": 42.0
}

Corner cases

Unfortunately, we cannot inject in non object values of produced JSON, so the library creates a wrapper object around non-object value:

encode (WithId 0 "non-object" :: WithId Int String)
{
  "id": 0 
, "value": "non-object"
}

The same story is about WithFields data type:

encode (WithFields 0 "non-object" :: WithFields Int String)
{
  "injected": 0 
, "value": "non-object"
}

For more examples and details, please, follow the haddocks.

Changes

1.1.0.0

  • Fix #1 bug.
  • FromJSON (WithFields a b) now requires ToJSON a to catch fields that should be removed from b JSON object before parsing.

1.0.10.0

  • Push upper bounds for base-4.10.

1.0.9.0

  • Push upper bounds for servant-docs-0.11.

1.0.8.0

  • Push upper bounds for aeson-1.2.

1.0.7.0

  • Push upper bounds for aeson-1.1 and servant-0.10.

1.0.6.0

  • Push upper bounds for servant-docs up to 9.0

1.0.5.0

  • Add support for aeson-1.0.0.

1.0.4.0

  • Add Data.Aeson.Unit module.

1.0.3.0

1.0.2.0

  • Add OnlyField data type.