Class RESTSerializer

public

Defined in: ../serializer/addon/rest.js:18

Normally, applications will use the RESTSerializer by implementing the normalize method.

This allows you to do whatever kind of munging you need and is especially useful if your server is inconsistent and you need to do munging differently for many different kinds of responses.

See the normalize documentation for more information.

Across the Board Normalization

There are also a number of hooks that you might find useful to define across-the-board rules for your payload. These rules will be useful if your server is consistent, or if you're building an adapter for an infrastructure service, like Firebase, and want to encode service conventions.

For example, if all of your keys are underscored and all-caps, but otherwise consistent with the names you use in your models, you can implement across-the-board rules for how to convert an attribute name in your model to a key in your JSON.

        
              app/serializers/application.js
            
              import RESTSerializer from '@ember-data/serializer/rest';
import { underscore } from '@ember/string';

export default class ApplicationSerializer extends RESTSerializer {
  keyForAttribute(attr, method) {
    return underscore(attr).toUpperCase();
  }
}

app/serializers/application.js
1 2 3 4 5 6 7 8	import RESTSerializer from '@ember-data/serializer/rest'; import { underscore } from '@ember/string'; export default class ApplicationSerializer extends RESTSerializer { keyForAttribute(attr, method) { return underscore(attr).toUpperCase(); } }

You can also implement keyForRelationship, which takes the name of the relationship as the first parameter, the kind of relationship (hasMany or belongsTo) as the second parameter, and the method (serialize or deserialize) as the third parameter. @mainName @ember-data/serializer/rest @tag main

Show: Inherited Protected Private Deprecated

extractAttributes (modelClass, resourceHash) Object public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:633

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

extractErrors (store, typeClass, payload, id) Object public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1378

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

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

This serializer expects this errors object to be an Array similar to the following, compliant with the https://jsonapi.org/format/#errors specification:

        
          
              
              {
  "errors": [
    {
      "detail": "This username is already taken!",
      "source": {
        "pointer": "data/attributes/username"
      }
    }, {
      "detail": "Doesn't look like a valid email.",
      "source": {
        "pointer": "data/attributes/email"
      }
    }
  ]
}
            

        
      

The key detail provides a textual description of the problem. Alternatively, the key title can be used for the same purpose.

The nested keys source.pointer detail which specific element of the request data was invalid.

Note that JSON-API also allows for object-level errors to be placed in an object with pointer data, signifying that the problem cannot be traced to a specific attribute:

        
              {
  "errors": [
    {
      "detail": "Some generic non property error message",
      "source": {
        "pointer": "data"
      }
    }
  ]
}

When turn into a Errors object, you can read these errors through the property base:

        
              {{#each @model.errors.base as |error|}}
  <div class="error">
    {{error.message}}
  </div>
{{/each}}

Example of alternative implementation, overriding the default behavior to deal with a different format of errors:

        
              app/serializers/post.js
            
              import JSONSerializer from '@ember-data/serializer/json';

export default class PostSerializer extends JSONSerializer {
  extractErrors(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 JSONSerializer from '@ember-data/serializer/json'; export default class PostSerializer extends JSONSerializer { extractErrors(store, typeClass, payload, id) { if (payload && typeof payload === 'object' && payload._problems) { payload = payload._problems; this.normalizeErrors(typeClass, payload); } return payload; } }

extractId (modelClass, resourceHash) String public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:618

modelClass: Object
resourceHash: Object
returns: String

Returns the resource's ID.

extractMeta (store, modelClass, payload) public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1343

store: Store
modelClass: 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 JSONSerializer from '@ember-data/serializer/json';

export default class PostSerializer extends JSONSerializer {
  extractMeta(store, typeClass, payload) {
    if (payload && payload.hasOwnProperty('_pagination')) {
      let meta = payload._pagination;
      delete payload._pagination;
      return meta;
    }
  }
}

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11	import JSONSerializer from '@ember-data/serializer/json'; export default class PostSerializer extends JSONSerializer { extractMeta(store, typeClass, payload) { if (payload && payload.hasOwnProperty('_pagination')) { let meta = payload._pagination; delete payload._pagination; return meta; } } }

extractPolymorphicRelationship (relationshipType, relationshipHash, relationshipOptions) Object public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:744

relationshipType: Object
relationshipHash: Object
relationshipOptions: Object
returns: Object

You can use this method to customize how a polymorphic relationship should be extracted.

extractRelationship (relationshipModelName, relationshipHash) Object public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:658

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 public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:717

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

keyForAttribute (key, method) String public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1490

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 JSONSerializer from '@ember-data/serializer/json';
import { underscore } from '@ember/string';

export default class ApplicationSerializer extends JSONSerializer {
  keyForAttribute(attr, method) {
    return underscore(attr).toUpperCase();
  }
}

app/serializers/application.js
1 2 3 4 5 6 7 8	import JSONSerializer from '@ember-data/serializer/json'; import { underscore } from '@ember/string'; export default class ApplicationSerializer extends JSONSerializer { keyForAttribute(attr, method) { return underscore(attr).toUpperCase(); } }

keyForLink (key, kind) String public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1546

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

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

keyForPolymorphicType (key, typeClass, method) String public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:63

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

keyForPolymorphicType can be used to define a custom key when serializing and deserializing a polymorphic type. By default, the returned key is ${key}Type.

Example

        
              app/serializers/post.js
            
              import RESTSerializer from '@ember-data/serializer/rest';

export default class ApplicationSerializer extends RESTSerializer {
  keyForPolymorphicType(key, relationship) {
    let relationshipKey = this.keyForRelationship(key);

    return 'type-' + relationshipKey;
  }
}

app/serializers/post.js
1 2 3 4 5 6 7 8 9	import RESTSerializer from '@ember-data/serializer/rest'; export default class ApplicationSerializer extends RESTSerializer { keyForPolymorphicType(key, relationship) { let relationshipKey = this.keyForRelationship(key); return 'type-' + relationshipKey; } }

keyForRelationship (key, typeClass, method) String public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1517

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 JSONSerializer from '@ember-data/serializer/json';
import { underscore } from '@ember/string';

export default class PostSerializer extends JSONSerializer {
  keyForRelationship(key, relationship, method) {
    return `rel_${underscore(key)}`;
  }
}

app/serializers/post.js
1 2 3 4 5 6 7 8	import JSONSerializer from '@ember-data/serializer/json'; import { underscore } from '@ember/string'; export default class PostSerializer extends JSONSerializer { keyForRelationship(key, relationship, method) { return `rel_${underscore(key)}`; } }

modelNameFromPayloadKey (key) String public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:417

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

This method is used to convert each JSON root key in the payload into a modelName that it can use to look up the appropriate model for that part of the payload.

For example, your server may send a model name that does not correspond with the name of the model in your app. Let's take a look at an example model, and an example payload:

        
              app/models/post.js
            
              import Model from '@ember-data/model';

export default class Post extends Model {}

app/models/post.js
1 2 3	import Model from '@ember-data/model'; export default class Post extends Model {}

        
                {
    "blog/post": {
      "id": "1
    }
  }

Ember Data is going to normalize the payload's root key for the modelName. As a result, it will try to look up the "blog/post" model. Since we don't have a model called "blog/post" (or a file called app/models/blog/post.js in ember-cli), Ember Data will throw an error because it cannot find the "blog/post" model.

Since we want to remove this namespace, we can define a serializer for the application that will remove "blog/" from the payload key whenver it's encountered by Ember Data:

        
              app/serializers/application.js
            
              import RESTSerializer from '@ember-data/serializer/rest';

export default class ApplicationSerializer extends RESTSerializer {
  modelNameFromPayloadKey(payloadKey) {
    if (payloadKey === 'blog/post') {
      return super.modelNameFromPayloadKey(payloadKey.replace('blog/', ''));
    } else {
     return super.modelNameFromPayloadKey(payloadKey);
    }
  }
}

app/serializers/application.js
1 2 3 4 5 6 7 8 9 10 11	import RESTSerializer from '@ember-data/serializer/rest'; export default class ApplicationSerializer extends RESTSerializer { modelNameFromPayloadKey(payloadKey) { if (payloadKey === 'blog/post') { return super.modelNameFromPayloadKey(payloadKey.replace('blog/', '')); } else { return super.modelNameFromPayloadKey(payloadKey); } } }

After refreshing, Ember Data will appropriately look up the "post" model.

By default the modelName for a model is its name in dasherized form. This means that a payload key like "blogPost" would be normalized to "blog-post" when Ember Data looks up the model. Usually, Ember Data can use the correct inflection to do this for you. Most of the time, you won't need to override modelNameFromPayloadKey for this purpose.

normalize (modelClass, resourceHash, prop) Object public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:95

modelClass: Model
resourceHash: Object
prop: String
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 Model class), the property where the hash was originally found, and the hash to normalize.

For example, if you have a payload that looks like this:

        
          
              
              {
  "post": {
    "id": 1,
    "title": "Rails is omakase",
    "comments": [ 1, 2 ]
  },
  "comments": [{
    "id": 1,
    "body": "FIRST"
  }, {
    "id": 2,
    "body": "Rails is unagi"
  }]
}
            

        
      

The normalize method will be called three times:

With App.Post, "posts" and { id: 1, title: "Rails is omakase", ... }
With App.Comment, "comments" and { id: 1, body: "FIRST" }
With App.Comment, "comments" and { id: 2, body: "Rails is unagi" }

You can use this method, for example, to normalize underscored keys to camelized or other general-purpose normalizations. You will only need to implement normalize and manipulate the payload as desired.

For example, if the IDs under "comments" are provided as _id instead of id, you can specify how to normalize just the comments:

        
              app/serializers/post.js
            
              import RESTSerializer from '@ember-data/serializer/rest';

export default class ApplicationSerializer extends RESTSerializer {
  normalize(model, hash, prop) {
    if (prop === 'comments') {
      hash.id = hash._id;
      delete hash._id;
    }

    return super.normalize(...arguments);
  }
}

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12	import RESTSerializer from '@ember-data/serializer/rest'; export default class ApplicationSerializer extends RESTSerializer { normalize(model, hash, prop) { if (prop === 'comments') { hash.id = hash._id; delete hash._id; } return super.normalize(...arguments); } }

On each call to the normalize method, the third parameter (prop) is always one of the keys that were in the original payload or in the result of another normalization as normalizeResponse.

normalize (typeClass, hash) Object public

Module: @ember-data/serializer/rest

Inherited from Serializer ../serializer/addon/index.ts:227

typeClass: Model
hash: Object
returns: Object

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.

Example:

        
              Serializer.extend({
  normalize(modelClass, resourceHash) {
    let data = {
      id:            resourceHash.id,
      type:          modelClass.modelName,
      attributes:    resourceHash
    };
    return { data: data };
  }
})

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:487

Available since v1.13.0

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

normalizeQueryResponse, normalizeFindManyResponse, and normalizeFindHasManyResponse delegate to this method by default.

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:397

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is createRecord

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:415

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is deleteRecord

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:307

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is findAll

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:325

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is findBelongsTo

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:343

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is findHasMany

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:361

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is findMany

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:271

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is findRecord

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:289

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is queryRecord

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:379

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is query

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:210

Available since v1.13.0

store: Store
primaryModelClass: 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 super.normalizeResponse(store, primaryModelClass, payload, id, requestType) with your pre-processed data.

Here's an example of using normalizeResponse manually:

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

  store.push(normalized);
});

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:451

Available since v1.13.0

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

normalizeUpdateRecordResponse, normalizeCreateRecordResponse and normalizeDeleteRecordResponse delegate to this method by default.

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:469

Available since v1.13.0

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

normalizeQueryResponse and normalizeFindRecordResponse delegate to this method by default.

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

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:433

Available since v1.13.0

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

Called by the default normalizeResponse implementation when the type of request is updateRecord

payloadKeyFromModelName (modelName) String public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:670

modelName: String
returns: String

You can use payloadKeyFromModelName to override the root key for an outgoing request. By default, the RESTSerializer returns a camelized version of the model's name.

For a model called TacoParty, its modelName would be the string taco-party. The RESTSerializer will send it to the server with tacoParty as the root key in the JSON payload:

        
              {
  "tacoParty": {
    "id": "1",
    "location": "Matthew Beale's House"
  }
}

For example, your server may expect dasherized root objects:

        
              app/serializers/application.js
            
              import RESTSerializer from '@ember-data/serializer/rest';
import { dasherize } from '@ember/string';

export default class ApplicationSerializer extends RESTSerializer {
  payloadKeyFromModelName(modelName) {
    return dasherize(modelName);
  }
}

app/serializers/application.js
1 2 3 4 5 6 7 8	import RESTSerializer from '@ember-data/serializer/rest'; import { dasherize } from '@ember/string'; export default class ApplicationSerializer extends RESTSerializer { payloadKeyFromModelName(modelName) { return dasherize(modelName); } }

Given a TacoParty model, calling save on it would produce an outgoing request like:

        
              {
  "taco-party": {
    "id": "1",
    "location": "Matthew Beale's House"
  }
}

pushPayload (store, payload) public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:356

store: Store
payload: Object

This method allows you to push a payload containing top-level collections of records organized per type.

        
          
              
              {
  "posts": [{
    "id": "1",
    "title": "Rails is omakase",
    "author", "1",
    "comments": [ "1" ]
  }],
  "comments": [{
    "id": "1",
    "body": "FIRST"
  }],
  "users": [{
    "id": "1",
    "name": "@d2h"
  }]
}
            

        
      

It will first normalize the payload, so you can use this to push in data streaming in from your server structured the same way that fetches and saves are structured.

serialize (snapshot, options) Object public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:481

snapshot: 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 Model, { attr, belongsTo } from '@ember-data/model';

export default class Comment extends Model {
  @attr title
  @attr body

  @belongsTo('user') author
}

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

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 (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 RESTSerializer from '@ember-data/serializer/rest';

export default class ApplicationSerializer extends RESTSerializer {
  serialize(snapshot, options) {
    let 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 RESTSerializer from '@ember-data/serializer/rest'; export default class ApplicationSerializer extends RESTSerializer { serialize(snapshot, options) { let 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 RESTSerializer from '@ember-data/serializer/rest';
import { pluralize } from 'ember-inflector';

export default class ApplicationSerializer extends RESTSerializer {
  serialize(snapshot, options) {
    let 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(singularize(name)) + "_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 32	import RESTSerializer from '@ember-data/serializer/rest'; import { pluralize } from 'ember-inflector'; export default class ApplicationSerializer extends RESTSerializer { serialize(snapshot, options) { let 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(singularize(name)) + "_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 RESTSerializer from '@ember-data/serializer/rest';

export default class ApplicationSerializer extends RESTSerializer {
  serialize(snapshot, options) {
    let json = super.serialize(snapshot, options);

    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 RESTSerializer from '@ember-data/serializer/rest'; export default class ApplicationSerializer extends RESTSerializer { serialize(snapshot, options) { let json = super.serialize(snapshot, options); json.subject = json.title; delete json.title; return json; } }

serialize (snapshot, options) Object public

Module: @ember-data/serializer/rest

Inherited from Serializer ../serializer/addon/index.ts:184

snapshot: Snapshot
options: Object
returns: Object

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.

Example:

        
          
              
              Serializer.extend({
  serialize(snapshot, options) {
    let json = {
      id: snapshot.id
    };

    snapshot.eachAttribute((key, attribute) => {
      json[key] = snapshot.attr(key);
    });

    snapshot.eachRelationship((key, relationship) => {
      if (relationship.kind === 'belongsTo') {
        json[key] = snapshot.belongsTo(key, { id: true });
      } else if (relationship.kind === 'hasMany') {
        json[key] = snapshot.hasMany(key, { ids: true });
      }
    });

    return json;
  },
});
            

        
      

serializeAttribute (snapshot, json, key, attribute) public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1160

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

serializeAttribute can be used to customize how 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 JSONSerializer from '@ember-data/serializer/json';

export default class ApplicationSerializer extends JSONSerializer {
  serializeAttribute(snapshot, json, key, attributes) {
    json.attributes = json.attributes || {};
    super.serializeAttribute(snapshot, json.attributes, key, attributes);
  }
}

app/serializers/application.js
1 2 3 4 5 6 7 8	import JSONSerializer from '@ember-data/serializer/json'; export default class ApplicationSerializer extends JSONSerializer { serializeAttribute(snapshot, json, key, attributes) { json.attributes = json.attributes \|\| {}; super.serializeAttribute(snapshot, json.attributes, key, attributes); } }

serializeBelongsTo (snapshot, json, relationship) public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1207

snapshot: Snapshot
json: Object
relationship: Object

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

Example

        
              app/serializers/post.js
            
              import JSONSerializer from '@ember-data/serializer/json';
import { isNone } from '@ember/utils';

export default class PostSerializer extends JSONSerializer {
  serializeBelongsTo(snapshot, json, relationship) {
    let key = relationship.key;
    let belongsTo = snapshot.belongsTo(key);

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

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

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

serializeHasMany (snapshot, json, relationship) public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:1261

snapshot: Snapshot
json: Object
relationship: Object

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

Example

        
              app/serializers/post.js
            
              import JSONSerializer from '@ember-data/serializer/json';

export default class PostSerializer extends JSONSerializer {
  serializeHasMany(snapshot, json, relationship) {
    let key = relationship.key;
    if (key === 'comments') {
      return;
    } else {
      super.serializeHasMany(...arguments);
    }
  }
}

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12	import JSONSerializer from '@ember-data/serializer/json'; export default class PostSerializer extends JSONSerializer { serializeHasMany(snapshot, json, relationship) { let key = relationship.key; if (key === 'comments') { return; } else { super.serializeHasMany(...arguments); } } }

serializeIntoHash (hash, typeClass, snapshot, options) public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:638

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

You can use this method to customize the root keys serialized into the JSON. The hash property should be modified by reference (possibly using something like _.extend) By default the REST Serializer sends the modelName of a model, which is a camelized version of the name.

For example, your server may expect underscored root objects.

        
              app/serializers/application.js
            
              import RESTSerializer from '@ember-data/serializer/rest';
import { decamelize } from '@ember/string';

export default class ApplicationSerializer extends RESTSerializer {
  serializeIntoHash(data, type, record, options) {
    let root = decamelize(type.modelName);
    data[root] = this.serialize(record, options);
  }
}

app/serializers/application.js
1 2 3 4 5 6 7 8 9	import RESTSerializer from '@ember-data/serializer/rest'; import { decamelize } from '@ember/string'; export default class ApplicationSerializer extends RESTSerializer { serializeIntoHash(data, type, record, options) { let root = decamelize(type.modelName); data[root] = this.serialize(record, options); } }

serializePolymorphicType (snapshot, json, relationship) public

Module: @ember-data/serializer/rest

Defined in ../serializer/addon/rest.js:721

snapshot: Snapshot
json: Object
relationship: Object

You can use this method to customize how polymorphic objects are serialized. By default the REST Serializer creates the key by appending Type to the attribute and value from the model's camelcased model name.

shouldSerializeHasMany (snapshot, key, relationshipType) Boolean public

Module: @ember-data/serializer/rest

Inherited from JSONSerializer ../serializer/addon/json.js:927

snapshot: Snapshot
key: String
relationshipType: String
returns: Boolean; true if the hasMany relationship should be serialized

Check if the given hasMany relationship should be serialized

By default only many-to-many and many-to-none relationships are serialized. This could be configured per relationship by Serializer's attrs object.