limited-effort/snfoil-rails

View on GitHub
lib/generators/snfoil/jsonapi_serializer/templates/jsonapi_serializer.erb

Summary

Maintainability
Test Coverage
# frozen_string_literal: true

class <%= class_modules %><%= class_name %>JsonapiSerializer
  include SnFoil::JsonapiSerializer

  set_id :id
  set_type :<%= name.pluralize.dasherize %>

  # SnFoil::JsonapiSerializer is just a wrapper for jsonapi-serializer (https://github.com/jsonapi-serializer/jsonapi-serializer)
  # with some defaults added in

  # Add attributes of the model you want to serializer with the following syntax
  # attributes :name
  #            :description
  #            :logo_url

  # Add relationships with the following syntax
  # belongs_to :store, serializer: Jsonapi::StoreJsonapiSerializer
  # has_many :locations, serializer: Jsonapi::LocationJsonapiSerializer
end