ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
9c3431db9e
active_model_serializers/docs/general/configuration_options.md
Benjamin Fleischer ce17a1b305 [DOCS] Refactor, update, create documentation [ci skip]
2015-12-14 14:38:29 -06:00

1.0 KiB
Raw Blame History

Back to Guides

Configuration Options

The following configuration options can be set on ActiveModelSerializers.config, preferably inside an initializer.

General

  • adapter: The adapter to use. Possible values: :attributes, :json, :json_api. Default: :attributes.

JSON API

  • jsonapi_resource_type: Whether the type attributes of resources should be singular or plural. Possible values: :singular, :plural. Default: :plural.
  • jsonapi_include_toplevel_object: Whether to include a top level JSON API member in the response document. Default: false.
  • Used when jsonapi_include_toplevel_object is true:
    • jsonapi_version: The latest version of the spec the API conforms to. Default: '1.0'.
    • jsonapi_toplevel_meta: Optional metadata. Not included if empty. Default: {}.

Hooks

To run a hook when ActiveModelSerializers is loaded, use ActiveSupport.on_load(:active_model_serializers) do end