Serializer Class
⚠️ CAUTION you likely want the docs for
Serializer as extending this abstract class is unnecessary.
Serializer
is an abstract base class that you may override in your
application to customize it for your backend. The minimum set of methods
that you should implement is:
normalizeResponse()
serialize()
And you can optionally override the following methods:
normalize()
For an example implementation, see JSONSerializer, the included JSON serializer.
Methods
normalize
-
typeClass
-
hash
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 };
}
})
Parameters:
-
typeClass
Model -
hash
Object
Returns:
normalizeResponse
-
store
-
primaryModelClass
-
payload
-
id
-
requestType
The normalizeResponse
method is used to normalize a payload from the
server to a JSON-API Document.
http://jsonapi.org/format/#document-structure
Example:
Serializer.extend({
normalizeResponse(store, primaryModelClass, payload, id, requestType) {
if (requestType === 'findRecord') {
return this.normalize(primaryModelClass, payload);
} else {
return payload.reduce(function(documentHash, item) {
let { data, included } = this.normalize(primaryModelClass, item);
documentHash.included.push(...included);
documentHash.data.push(data);
return documentHash;
}, { data: [], included: [] })
}
}
});
Parameters:
Returns:
JSON-API Document
serialize
-
snapshot
-
[options]
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 istrue
,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;
},
});
Parameters:
-
snapshot
Snapshot -
[options]
Object optional
Returns:
Properties
store
Store
public
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);
}
});