• Version 4.0.1
  • Published
  • 50.2 kB
  • 5 dependencies
  • MIT license


npm i active-model-adapter
yarn add active-model-adapter
pnpm add active-model-adapter


Adapters and Serializers for Rails's ActiveModel::Serializers



class ActiveModelAdapter

class ActiveModelAdapter extends RESTAdapter {}
  • The ActiveModelAdapter is a subclass of the RESTAdapter designed to integrate with a JSON API that uses an underscored naming convention instead of camelCasing. It has been designed to work out of the box with the [active\_model\_serializers]( Ruby gem. This Adapter expects specific settings using ActiveModel::Serializers, embed :ids, embed_in_root: true which sideloads the records.

    This adapter extends the DS.RESTAdapter by making consistent use of the camelization, decamelization and pluralization methods to normalize the serialized JSON into a format that is compatible with a conventional Rails backend and Ember Data.

    ## JSON Structure

    The ActiveModelAdapter expects the JSON returned from your server to follow the REST adapter conventions substituting underscored keys for camelcased ones.

    Unlike the DS.RESTAdapter, async relationship keys must be the singular form of the relationship name, followed by "_id" for DS.belongsTo relationships, or "_ids" for DS.hasMany relationships.

    ### Conventional Names

    Attribute names in your JSON payload should be the underscored versions of the attributes in your Ember.js models.

    For example, if you have a Person model:

    export default class FamousPerson extends Model {
    @attr() firstName;
    @attr() lastName;
    @attr() occupation;

    The JSON returned should look like this:

    "famous_person": {
    "id": 1,
    "first_name": "Barack",
    "last_name": "Obama",
    "occupation": "President"

    Let's imagine that Occupation is just another model:

    export default class Person extends Model {
    @attr() firstName;
    @attr() lastName;
    @belongsTo('occupation') occupation;
    export default class Occupation extends Model {
    @attr() name;
    @attr('number') salary;
    @hasMany('person') people;

    The JSON needed to avoid extra server calls, should look like this:

    "people": [{
    "id": 1,
    "first_name": "Barack",
    "last_name": "Obama",
    "occupation_id": 1
    "occupations": [{
    "id": 1,
    "name": "President",
    "salary": 100000,
    "person_ids": [1]

    ActiveModelAdapter DS DS.RESTAdapter

property defaultSerializer

defaultSerializer: string;

    method handleResponse

    handleResponse: (
    status: number,
    headers: AnyObject,
    payload: ActiveModelPayload,
    requestData: AnyObject | AdapterError
    ) => any;
    • The ActiveModelAdapter overrides the handleResponse method to format errors passed to a DS.InvalidError for all 422 Unprocessable Entity responses.

      A 422 HTTP response from the server generally implies that the request was well formed but the API was unable to process it because the content was not semantically correct or meaningful per the API.

      For more information on 422 HTTP Error code see 11.2 WebDAV RFC 4918


      Parameter status

      Parameter headers

      Parameter payload

      {Object | AdapterError} response

    method pathForType

    pathForType: <K extends string | number | symbol>(modelName: K) => string;
    • The ActiveModelAdapter overrides the pathForType method to build underscored URLs by decamelizing and pluralizing the object type name.

      //=> "famous_people"


      Parameter modelName


    Package Files (1)

    Dependencies (5)

    Dev Dependencies (69)

    Peer Dependencies (0)

    No peer dependencies.


    To add a badge like this badgeto your package's README, use the codes available below.

    You may also use to create a custom badge linking to

    • Markdown
    • HTML
      <a href=""><img src="" alt=""></a>