Class DS.JSONSerializer

Defined in: packages/ember-data/lib/serializers/json-serializer.js:14

Module: ember-data

Ember Data 2.0 Serializer:

In Ember Data a Serializer is used to serialize and deserialize records when they are transferred in and out of an external source. This process involves normalizing property names, transforming attribute values and serializing relationships.

By default Ember Data recommends using the JSONApiSerializer.

JSONSerializer is useful for simpler or legacy backends that may not support the http://jsonapi.org/ spec.

JSONSerializer normalizes a JSON payload that looks like:

        
                App.User = DS.Model.extend({
    name: DS.attr(),
    friends: DS.hasMany('user'),
    house: DS.belongsTo('location'),
  });

        
                {
    id: 1,
    name: 'Sebastian',
    friends: [3, 4],
    links: {
      house: '/houses/lefkada'
    }
  }

to JSONApi format that the Ember Data store expects.

You can customize how JSONSerializer processes it's payload by passing options in the attrs hash or by subclassing the JSONSerializer and overriding hooks:

-To customize how a single record is normalized, use the normalize hook -To customize how JSONSerializer normalizes the whole server response, use the normalizeResponse hook -To customize how JSONSerializer normalizes a specific response from the server, use one of the many specific normalizeResponse hooks -To customize how JSONSerializer normalizes your id, attributes or relationships, use the extractId, extractAttributes and extractRelationships hooks.

JSONSerializer normalization process follows these steps:

normalizeResponse - entry method to the Serializer
normalizeCreateRecordResponse - a normalizeResponse for a specific operation is called
normalizeSingleResponse|normalizeArrayResponse - for methods like createRecord we expect a single record back, while for methods like findAll we expect multiple methods back
normalize - normalizeArray iterates and calls normalize for each of it's records while normalizeSingle calls it once. This is the method you most likely want to subclass
extractId | extractAttributes | extractRelationships - normalize delegates to these methods to turn the record payload into the JSONApi format

Show: Inherited Protected Private Deprecated

extract (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1209

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

The extract method is used to deserialize payload data from the server. By default the JSONSerializer does not push the records into the store. However records that subclass JSONSerializer such as the RESTSerializer may push records into the store as part of the extract call.

This method delegates to a more specific extract method based on the requestType.

To override this method with a custom one, make sure to call return this._super(store, type, payload, id, requestType) with your pre-processed data.

Here's an example of using extract manually:

        
              socket.on('message', function(message) {
  var data = message.data;
  var typeClass = store.modelFor(message.modelName);
  var serializer = store.serializerFor(typeClass.modelName);
  var record = serializer.extract(store, typeClass, data, data.id, 'single');

  store.push(message.modelName, record);
});

extractArray (store, typeClass, arrayPayload, id, requestType) Array

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1470

store: DS.Store
typeClass: DS.Model
arrayPayload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractArray is used to deserialize an array of records returned from the adapter.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  extractArray: function(store, typeClass, payload) {
    return payload.map(function(json) {
      return this.extractSingle(store, typeClass, json);
    }, this);
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ extractArray: function(store, typeClass, payload) { return payload.map(function(json) { return this.extractSingle(store, typeClass, json); }, this); } });

extractAttributes (modelClass, resourceHash) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:527

modelClass: Object
resourceHash: Object
returns: Object

Returns the resource's attributes formatted as a JSON-API "attributes object".

http://jsonapi.org/format/#document-resource-object-attributes

extractCreateRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1332

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractCreateRecord is a hook into the extract method used when a call is made to DS.Model#save and the record is new. By default this method is alias for extractSave.

extractDeleteRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1364

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractDeleteRecord is a hook into the extract method used when a call is made to DS.Model#save and the record has been deleted. By default this method is alias for extractSave.

extractErrors (store, typeClass, payload, id) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1548

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
returns: Object; json The deserialized errors

extractErrors is used to extract model errors when a call is made to DS.Model#save which fails with an InvalidError. By default Ember Data expects error information to be located on the errors property of the payload object.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  extractErrors: function(store, typeClass, payload, id) {
    if (payload && typeof payload === 'object' && payload._problems) {
      payload = payload._problems;
      this.normalizeErrors(typeClass, payload);
    }
    return payload;
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ extractErrors: function(store, typeClass, payload, id) { if (payload && typeof payload === 'object' && payload._problems) { payload = payload._problems; this.normalizeErrors(typeClass, payload); } return payload; } });

extractFind (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1381

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractFind is a hook into the extract method used when a call is made to DS.Store#find. By default this method is alias for extractSingle.

extractFindAll (store, typeClass, payload, id, requestType) Array

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1251

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindAll is a hook into the extract method used when a call is made to DS.Store#findAll. By default this method is an alias for extractArray.

extractFindBelongsTo (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1398

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractFindBelongsTo is a hook into the extract method used when a call is made to DS.Store#findBelongsTo. By default this method is alias for extractSingle.

extractFindHasMany (store, typeClass, payload, id, requestType) Array

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1315

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindHasMany is a hook into the extract method used when a call is made to DS.Store#findHasMany. By default this method is alias for extractArray.

extractFindMany (store, typeClass, payload, id, requestType) Array

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1299

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindMany is a hook into the extract method used when a call is made to DS.Store#findMany. By default this method is alias for extractArray.

extractFindQuery (store, typeClass, payload, id, requestType) Array

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1267

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindQuery is a hook into the extract method used when a call is made to DS.Store#findQuery. By default this method is an alias for extractArray.

extractId (modelClass, resourceHash) String

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:513

modelClass: Object
resourceHash: Object
returns: String

Returns the resource's ID.

extractMeta (store, typeClass, payload)

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1512

store: DS.Store
typeClass: DS.Model
payload: Object

extractMeta is used to deserialize any meta information in the adapter payload. By default Ember Data expects meta information to be located on the meta property of the payload object.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  extractMeta: function(store, typeClass, payload) {
    if (payload && payload._pagination) {
      store.setMetadataFor(typeClass, payload._pagination);
      delete payload._pagination;
    }
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ extractMeta: function(store, typeClass, payload) { if (payload && payload._pagination) { store.setMetadataFor(typeClass, payload._pagination); delete payload._pagination; } } });

extractQueryRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1283

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; object A hash of deserialized object

extractQueryRecord is a hook into the extract method used when a call is made to DS.Store#queryRecord. By default this method is an alias for extractSingle.

extractRelationship (relationshipModelName, relationshipHash) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:551

relationshipModelName: Object
relationshipHash: Object
returns: Object

Returns a relationship formatted as a JSON-API "relationship object".

http://jsonapi.org/format/#document-resource-object-relationships

extractRelationships (modelClass, resourceHash) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:582

modelClass: Object
resourceHash: Object
returns: Object

Returns the resource's relationships formatted as a JSON-API "relationships object".

http://jsonapi.org/format/#document-resource-object-relationships

extractSave (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1414

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractSave is a hook into the extract method used when a call is made to DS.Model#save. By default this method is alias for extractSingle.

extractSingle (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1431

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractSingle is used to deserialize a single record returned from the adapter.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  extractSingle: function(store, typeClass, payload) {
    payload.comments = payload._embedded.comment;
    delete payload._embedded;

    return this._super(store, typeClass, payload);
  },
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ extractSingle: function(store, typeClass, payload) { payload.comments = payload._embedded.comment; delete payload._embedded; return this._super(store, typeClass, payload); }, });

extractUpdateRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1348

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractUpdateRecord is a hook into the extract method used when a call is made to DS.Model#save and the record has been updated. By default this method is alias for extractSave.

keyForAttribute (key, method) String

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1586

key: String
method: String
returns: String; normalized key

keyForAttribute can be used to define rules for how to convert an attribute name in your model to a key in your JSON.

Example

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  keyForAttribute: function(attr, method) {
    return Ember.String.underscore(attr).toUpperCase();
  }
});

app/serializers/application.js
1 2 3 4 5 6 7	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ keyForAttribute: function(attr, method) { return Ember.String.underscore(attr).toUpperCase(); } });

keyForLink (key, kind) String

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1638

key: String
kind: String; `belongsTo` or `hasMany`
returns: String; normalized key

keyForLink can be used to define a custom key when deserializing link properties.

keyForRelationship (key, typeClass, method) String

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1611

key: String
typeClass: String
method: String
returns: String; normalized key

keyForRelationship can be used to define a custom key when serializing and deserializing relationship properties. By default JSONSerializer does not provide an implementation of this method.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  keyForRelationship: function(key, relationship, method) {
    return 'rel_' + Ember.String.underscore(key);
  }
});

app/serializers/post.js
1 2 3 4 5 6 7	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ keyForRelationship: function(key, relationship, method) { return 'rel_' + Ember.String.underscore(key); } });

modelNameFromPayloadKey (key) String

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:626

key: String
returns: String; the model's modelName

normalize (typeClass, hash) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:460

typeClass: DS.Model
hash: Object
returns: Object

Normalizes a part of the JSON payload returned by the server. You should override this method, munge the hash and call super if you have generic normalization to do.

It takes the type of the record that is being normalized (as a DS.Model class), the property where the hash was originally found, and the hash to normalize.

You can use this method, for example, to normalize underscored keys to camelized or other general-purpose normalizations.

Example

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  normalize: function(typeClass, hash) {
    var fields = Ember.get(typeClass, 'fields');
    fields.forEach(function(field) {
      var payloadField = Ember.String.underscore(field);
      if (field === payloadField) { return; }

      hash[field] = hash[payloadField];
      delete hash[payloadField];
    });
    return this._super.apply(this, arguments);
  }
});

app/serializers/application.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ normalize: function(typeClass, hash) { var fields = Ember.get(typeClass, 'fields'); fields.forEach(function(field) { var payloadField = Ember.String.underscore(field); if (field === payloadField) { return; } hash[field] = hash[payloadField]; delete hash[payloadField]; }); return this._super.apply(this, arguments); } });

normalizeArrayResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:404

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeCreateRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:339

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeDeleteRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:352

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindAllResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:274

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindBelongsToResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:287

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindHasManyResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:300

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindManyResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:313

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:248

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeQueryRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:261

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeQueryResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:326

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:189

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

The normalizeResponse method is used to normalize a payload from the server to a JSON-API Document.

http://jsonapi.org/format/#document-structure

This method delegates to a more specific normalize method based on the requestType.

To override this method with a custom one, make sure to call return this._super(store, primaryModelClass, payload, id, requestType) with your pre-processed data.

Here's an example of using normalizeResponse manually:

        
              socket.on('message', function(message) {
  var data = message.data;
  var modelClass = store.modelFor(data.modelName);
  var serializer = store.serializerFor(data.modelName);
  var json = serializer.normalizeSingleResponse(store, modelClass, data, data.id);

  store.push(normalized);
});

normalizeSaveResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:378

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeSingleResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:391

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeUpdateRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:365

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

serialize (snapshot, options) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:824

snapshot: DS.Snapshot
options: Object
returns: Object; json

Called when a record is saved in order to convert the record into JSON.

By default, it creates a JSON object with a key for each attribute and belongsTo relationship.

For example, consider this model:

        
              app/models/comment.js
            
              import DS from 'ember-data';

export default DS.Model.extend({
  title: DS.attr(),
  body: DS.attr(),

  author: DS.belongsTo('user')
});

app/models/comment.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.Model.extend({ title: DS.attr(), body: DS.attr(), author: DS.belongsTo('user') });

The default serialization would create a JSON object like:

        
              {
  "title": "Rails is unagi",
  "body": "Rails? Omakase? O_O",
  "author": 12
}

By default, attributes are passed through as-is, unless you specified an attribute type (DS.attr('date')). If you specify a transform, the JavaScript value will be serialized when inserted into the JSON hash.

By default, belongs-to relationships are converted into IDs when inserted into the JSON hash.

IDs

serialize takes an options hash with a single option: includeId. If this option is true, serialize will, by default include the ID in the JSON object it builds.

The adapter passes in includeId: true when serializing a record for createRecord, but not for updateRecord.

Customization

Your server may expect a different JSON format than the built-in serialization format.

In that case, you can implement serialize yourself and return a JSON hash of your choosing.

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serialize: function(snapshot, options) {
    var json = {
      POST_TTL: snapshot.attr('title'),
      POST_BDY: snapshot.attr('body'),
      POST_CMS: snapshot.hasMany('comments', { ids: true })
    }

    if (options.includeId) {
      json.POST_ID_ = snapshot.id;
    }

    return json;
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serialize: function(snapshot, options) { var json = { POST_TTL: snapshot.attr('title'), POST_BDY: snapshot.attr('body'), POST_CMS: snapshot.hasMany('comments', { ids: true }) } if (options.includeId) { json.POST_ID_ = snapshot.id; } return json; } });

Customizing an App-Wide Serializer

If you want to define a serializer for your entire application, you'll probably want to use eachAttribute and eachRelationship on the record.

        
          
              app/serializers/application.js
            

          
              
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serialize: function(snapshot, options) {
    var json = {};

    snapshot.eachAttribute(function(name) {
      json[serverAttributeName(name)] = snapshot.attr(name);
    })

    snapshot.eachRelationship(function(name, relationship) {
      if (relationship.kind === 'hasMany') {
        json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
      }
    });

    if (options.includeId) {
      json.ID_ = snapshot.id;
    }

    return json;
  }
});

function serverAttributeName(attribute) {
  return attribute.underscore().toUpperCase();
}

function serverHasManyName(name) {
  return serverAttributeName(name.singularize()) + "_IDS";
}
            

        
      

app/serializers/application.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serialize: function(snapshot, options) { var json = {}; snapshot.eachAttribute(function(name) { json[serverAttributeName(name)] = snapshot.attr(name); }) snapshot.eachRelationship(function(name, relationship) { if (relationship.kind === 'hasMany') { json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true }); } }); if (options.includeId) { json.ID_ = snapshot.id; } return json; } }); function serverAttributeName(attribute) { return attribute.underscore().toUpperCase(); } function serverHasManyName(name) { return serverAttributeName(name.singularize()) + "_IDS"; }

This serializer will generate JSON that looks like this:

        
              {
  "TITLE": "Rails is omakase",
  "BODY": "Yep. Omakase.",
  "COMMENT_IDS": [ 1, 2, 3 ]
}

Tweaking the Default JSON

If you just want to do some small tweaks on the default JSON, you can call super first and make the tweaks on the returned JSON.

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serialize: function(snapshot, options) {
    var json = this._super.apply(this, arguments);

    json.subject = json.title;
    delete json.title;

    return json;
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serialize: function(snapshot, options) { var json = this._super.apply(this, arguments); json.subject = json.title; delete json.title; return json; } });

serializeAttribute (snapshot, json, key, attribute)

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1031

snapshot: DS.Snapshot
json: Object
key: String
attribute: Object

serializeAttribute can be used to customize how DS.attr properties are serialized

For example if you wanted to ensure all your attributes were always serialized as properties on an attributes object you could write:

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serializeAttribute: function(snapshot, json, key, attributes) {
    json.attributes = json.attributes || {};
    this._super(snapshot, json.attributes, key, attributes);
  }
});

app/serializers/application.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serializeAttribute: function(snapshot, json, key, attributes) { json.attributes = json.attributes \|\| {}; this._super(snapshot, json.attributes, key, attributes); } });

serializeBelongsTo (snapshot, json, relationship)

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1078

snapshot: DS.Snapshot
json: Object
relationship: Object

serializeBelongsTo can be used to customize how DS.belongsTo properties are serialized.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serializeBelongsTo: function(snapshot, json, relationship) {
    var key = relationship.key;

    var belongsTo = snapshot.belongsTo(key);

    key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key;

    json[key] = Ember.isNone(belongsTo) ? belongsTo : belongsTo.record.toJSON();
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12 13	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serializeBelongsTo: function(snapshot, json, relationship) { var key = relationship.key; var belongsTo = snapshot.belongsTo(key); key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key; json[key] = Ember.isNone(belongsTo) ? belongsTo : belongsTo.record.toJSON(); } });

serializeHasMany (snapshot, json, relationship)

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1131

snapshot: DS.Snapshot
json: Object
relationship: Object

serializeHasMany can be used to customize how DS.hasMany properties are serialized.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serializeHasMany: function(snapshot, json, relationship) {
    var key = relationship.key;
    if (key === 'comments') {
      return;
    } else {
      this._super.apply(this, arguments);
    }
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serializeHasMany: function(snapshot, json, relationship) { var key = relationship.key; if (key === 'comments') { return; } else { this._super.apply(this, arguments); } } });

serializeIntoHash (hash, typeClass, snapshot, options)

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1001

hash: Object
typeClass: DS.Model
snapshot: DS.Snapshot
options: Object

You can use this method to customize how a serialized record is added to the complete JSON hash to be sent to the server. By default the JSON Serializer does not namespace the payload and just sends the raw serialized JSON object. If your server expects namespaced keys, you should consider using the RESTSerializer. Otherwise you can override this method to customize how the record is added to the hash.

For example, your server may expect underscored root objects.

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  serializeIntoHash: function(data, type, snapshot, options) {
    var root = Ember.String.decamelize(type.modelName);
    data[root] = this.serialize(snapshot, options);
  }
});

app/serializers/application.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ serializeIntoHash: function(data, type, snapshot, options) { var root = Ember.String.decamelize(type.modelName); data[root] = this.serialize(snapshot, options); } });

serializePolymorphicType (snapshot, json, relationship)

Module: ember-data

Defined in packages/ember-data/lib/serializers/json-serializer.js:1174

snapshot: DS.Snapshot
json: Object
relationship: Object

You can use this method to customize how polymorphic objects are serialized. Objects are considered to be polymorphic if { polymorphic: true } is pass as the second argument to the DS.belongsTo function.

Example

        
              app/serializers/comment.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serializePolymorphicType: function(snapshot, json, relationship) {
    var key = relationship.key,
        belongsTo = snapshot.belongsTo(key);
    key = this.keyForAttribute ? this.keyForAttribute(key, "serialize") : key;

    if (Ember.isNone(belongsTo)) {
      json[key + "_type"] = null;
    } else {
      json[key + "_type"] = belongsTo.modelName;
    }
  }
});