Module: ActiveModelSerializers::Jsonapi

Defined in:: lib/active_model_serializers/register_jsonapi_renderer.rb

Overview

Based on discussion in github.com/rails/rails/pull/23712#issuecomment-184977238, the JSON API media type will have its own format/renderer.

> We recommend the media type be registered on its own as jsonapi when a jsonapi Renderer and deserializer (Http::Parameters::DEFAULT_PARSERS) are added.

Usage:

ActiveSupport.on_load(:action_controller) do

require 'active_model_serializers/register_jsonapi_renderer'

end

And then in controllers, use `render jsonapi: model` rather than `render json: model, adapter: :json_api`.

For example, in a controller action, we can: respond_to do |format|

format.jsonapi { render jsonapi: model }

end

render jsonapi: model

No wrapper format needed as it does not apply (i.e. no `wrap_parameters format: [jsonapi]`)

Defined Under Namespace

Modules: ControllerSupport

Constant Summary

MEDIA_TYPE =

'application/vnd.api+json'.freeze

HEADERS =

{
  response: { 'CONTENT_TYPE'.freeze => MEDIA_TYPE },
  request:  { 'ACCEPT'.freeze => MEDIA_TYPE }
}.freeze