• Introduction
• Getting started
  • Plain ruby
  • Sinatra
  • Hanami
  • Ruby on Rails
• Serialization
  • Defining resources
  • Rendering resources
• Deserialization
  • Defining resources
  • Deserializing resources

Introduction

What is jsonapi-rb?

jsonapi-rb is a ruby library for producing and consuming JSON API documents. It is cleanly layered, has an intuitive yet intent-stating API, and no magic.

It is comprised of 4 independent micro-libraries:

• jsonapi-parser for syntactic validation of JSON API documents,
• jsonapi-renderer for low-level rendering of JSON API documents,
• jsonapi-serializable for building serializable resource classes from your business object – those are usually referred to as “serializers” in other libs,
• jsonapi-deserializable for building deserializable resource classes that transform an incoming JSON API payload into a custom hash,

and 2 framework integrations:

• jsonapi-rails for Ruby on Rails, with ActionController integration and generators,
• jsonapi-hanami for Hanami with Hanami::Controller::Action integration and (soon) generators.

Guides

These guides should get you up to speed with using jsonapi-rb. If you have more questions, feel free to drop by on Gitter.

• Getting started
• Serialization
• Deserialization