Ruby JSONAPI Documentation

Welcome to the Ruby JSONAPI documentation. This library provides fast and efficient JSON:API serialization for Ruby objects.

Overview

Ruby JSONAPI is a fork of the jsonapi-serializer gem (which was itself forked from Netflix’s fast_jsonapi). It adheres to the JSON:API specification while providing excellent performance.

Features

• Declaration syntax similar to Active Model Serializer
• Support for belongs_to, has_many and has_one
• Support for compound documents (included)
• Optimized serialization of compound documents
• Caching

Contents

• Installation
• Usage
  • Basic Serialization
  • Working with Relationships
  • Customization Options
  • Advanced Features
• Performance Considerations
• Migration from fast_jsonapi
• JSON Serialization

Project Status

Ruby JSONAPI is currently in active development. While it maintains feature parity with jsonapi-serializer, we are working toward implementing the enhanced features noted in our roadmap.

Getting Started

If you’re new to Ruby JSONAPI, start with the Installation guide and then move on to Basic Serialization.