Class JSONSerializer
publicEmber 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 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:
import Model, { attr, belongsTo, hasMany } from '@ember-data/model';
export default class UserModel extends Model {
@hasMany('user') friends;
@belongsTo('location') house;
@attr('string') name;
}
{
id: 1,
name: 'Sebastian',
friends: [3, 4],
links: {
house: '/houses/lefkada'
}
}
JSONSerializer
will normalize the JSON payload to the JSON API format that the
Ember Data store expects.
You can customize how JSONSerializer processes its 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 thenormalizeResponse
hook. - To customize how
JSONSerializer
normalizes a specific response from the server, use one of the many specificnormalizeResponse
hooks. - To customize how
JSONSerializer
normalizes your id, attributes or relationships, use theextractId
,extractAttributes
andextractRelationships
hooks.
The JSONSerializer
normalization process follows these steps:
normalizeResponse
- entry method to the serializer.
normalizeCreateRecordResponse
- a
normalizeResponse
for a specific operation is called.
- a
normalizeSingleResponse
|normalizeArrayResponse
- for methods like
createRecord
we expect a single record back, while for methods likefindAll
we expect multiple records back.
- for methods like
normalize
normalizeArrayResponse
iterates and callsnormalize
for each of its records whilenormalizeSingle
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 JSON API format. @mainName @ember-data/serializer/json @tag main
@_maintrue
Methods
- extractAttributes
- extractErrors
- extractId
- extractMeta
- extractPolymorphicRelationship
- extractRelationship
- extractRelationships
- keyForAttribute
- keyForLink
- keyForRelationship
- modelNameFromPayloadKey
- normalize
- normalizeArrayResponse
- normalizeCreateRecordResponse
- normalizeDeleteRecordResponse
- normalizeFindAllResponse
- normalizeFindBelongsToResponse
- normalizeFindHasManyResponse
- normalizeFindManyResponse
- normalizeFindRecordResponse
- normalizeQueryRecordResponse
- normalizeQueryResponse
- normalizeResponse
- normalizeSaveResponse
- normalizeSingleResponse
- normalizeUpdateRecordResponse
- serialize
- serializeAttribute
- serializeBelongsTo
- serializeHasMany
- serializeIntoHash
- serializePolymorphicType
- shouldSerializeHasMany
Properties
Events
No documented items