Class JSONSerializer

public
Extends: Serializer
Defined in: ../serializer/src/json.js:16
Module: @ember-data/serializer/json

⚠️ This is LEGACY documentation for a feature that is no longer encouraged to be used. If starting a new app or thinking of implementing a new adapter, consider writing a Handler instead to be used with the RequestManager

In EmberData 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, EmberData uses and recommends the JSONAPISerializer.

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

For example, given the following User model and JSON payload:

```js {data-filename=app/models/user.js} import Model, { attr, belongsTo, hasMany } from '@ember-data/model';

export default class UserModel extends Model {

Show:

attrs public

Module: @ember-data/serializer/json

Defined in ../packages/serializer/src/json.js:119

The attrs object can be used to declare a simple mapping between property names on Model records and payload keys in the serialized JSON object representing the record. An object with the property key can also be used to designate the attribute's key on the response payload.

Example

```js {data-filename=app/models/person.js} import Model, { attr } from '@ember-data/model';

export default class PersonModel extends Model {

primaryKey public

Module: @ember-data/serializer/json

Defined in ../packages/serializer/src/json.js:94

The primaryKey is used when serializing and deserializing data. Ember Data always uses the id property to store the id of the record. The external source may not always follow this convention. In these cases it is useful to override the primaryKey property to match the primaryKey of your external store.

Example

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

export default class ApplicationSerializer extends JSONSerializer {
  primaryKey = '_id'
}

store public

Module: @ember-data/serializer/json

Inherited from Serializer ../packages/serializer/src/index.ts:140

The store property is the application's store that contains all records. It can be used to look up serializers for other model types that may be nested inside the payload response.

Example:

Serializer.extend({
  extractRelationship(relationshipModelName, relationshipHash) {
    let modelClass = this.store.modelFor(relationshipModelName);
    let relationshipSerializer = this.store.serializerFor(relationshipModelName);
    return relationshipSerializer.normalize(modelClass, relationshipHash);
  }
});