Class DS.JSONAPISerializer

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 is used to deserialize an array of records returned from the adapter.

Example

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);
  }
});

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 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 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

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 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 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 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 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 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 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.

Returns the resource's ID.

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

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 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.

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 is used to deserialize a single record returned from the adapter.

Example

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 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 can be used to define rules for how to convert an attribute name in your model to a key in your JSON. By default JSONAPISerializer follows the format used on the examples of http://jsonapi.org/format and uses dashes as the word separator in the JSON attribute keys.

This behaviour can be easily customized by extending this method.

Example

import DS from 'ember-data';

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

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

keyForRelationship can be used to define a custom key when serializing and deserializing relationship properties. By default JSONAPISerializer follows the format used on the examples of http://jsonapi.org/format and uses dashes as word separators in relationship properties.

This behaviour can be easily customized by extending this method.

Example

 import DS from 'ember-data';

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

The normalize method is used to convert a payload received from your external data source into the normalized form store.push() expects. You should override this method, munge the hash and return the normalized payload.

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);
});

The serialize method is used when a record is saved in order to convert the record into the form that your external data source expects.

serialize takes an optional options hash with a single option:

• includeId: If this is true, serialize should include the ID in the serialized object it builds.

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.

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);
  }
});

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

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;
    }
  }
});