Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.22 KB

README.md

File metadata and controls

44 lines (27 loc) · 1.22 KB
Raw

JSONApi Build Status

JSON API Serializers for Crystal

Features

  • Easy serialization of basic JSON API objects
  • Built in caching support

Performance

JSONApi is very fast. Thanks to the built in caching support it outperforms vanilla .to_json by almost an order of magnitude. See the following graphic.

Performance plot

Installation

Add this to your application's shard.yml:

dependencies:
  json_api:
    github: jreinert/crystal-jsonapi

Usage

See examples/people.cr for a real-world example and examples/people.out.json for the generated output.

Contributing

  1. Fork it ( https://github.com/jreinert/crystal-jsonapi/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • jreinert Joakim Reinert - creator, maintainer