Class DS.RESTAdapter

Extends: DS.Adapter

Uses: DS.BuildURLMixin

Defined in: packages/ember-data/lib/adapters/rest-adapter.js:28

Module: ember-data

The REST adapter allows your store to communicate with an HTTP server by transmitting JSON via XHR. Most Ember.js apps that consume a JSON API should use the REST adapter.

This adapter is designed around the idea that the JSON exchanged with the server should be conventional.

JSON Structure

The REST adapter expects the JSON returned from your server to follow these conventions.

Object Root

The JSON payload should be an object that contains the record inside a root property. For example, in response to a GET request for /posts/1, the JSON should look like this:

        
              {
  "post": {
    "id": 1,
    "title": "I'm Running to Reform the W3C's Tag",
    "author": "Yehuda Katz"
  }
}

Similarly, in response to a GET request for /posts, the JSON should look like this:

        
          
              
              {
  "posts": [
    {
      "id": 1,
      "title": "I'm Running to Reform the W3C's Tag",
      "author": "Yehuda Katz"
    },
    {
      "id": 2,
      "title": "Rails is omakase",
      "author": "D2H"
    }
  ]
}
            

        
      

Conventional Names

Attribute names in your JSON payload should be the camelCased versions of the attributes in your Ember.js models.

For example, if you have a Person model:

        
              app/models/person.js
            
              import DS from 'ember-data';

export default DS.Model.extend({
  firstName: DS.attr('string'),
  lastName: DS.attr('string'),
  occupation: DS.attr('string')
});

app/models/person.js
1 2 3 4 5 6 7	import DS from 'ember-data'; export default DS.Model.extend({ firstName: DS.attr('string'), lastName: DS.attr('string'), occupation: DS.attr('string') });

The JSON returned should look like this:

        
              {
  "person": {
    "id": 5,
    "firstName": "Barack",
    "lastName": "Obama",
    "occupation": "President"
  }
}

Customization

Endpoint path customization

Endpoint paths can be prefixed with a namespace by setting the namespace property on the adapter:

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  namespace: 'api/1'
});

app/adapters/application.js
1 2 3 4 5	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ namespace: 'api/1' });

Requests for App.Person would now target /api/1/people/1.

Host customization

An adapter can target other hosts by setting the host property.

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  host: 'https://api.example.com'
});

app/adapters/application.js
1 2 3 4 5	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ host: 'https://api.example.com' });

Headers customization

Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary headers can be set as key/value pairs on the RESTAdapter's headers object and Ember Data will send them along with each ajax request.

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  headers: {
    "API_KEY": "secret key",
    "ANOTHER_HEADER": "Some header value"
  }
});

app/adapters/application.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ headers: { "API_KEY": "secret key", "ANOTHER_HEADER": "Some header value" } });

headers can also be used as a computed property to support dynamic headers. In the example below, the session object has been injected into an adapter by Ember's container.

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  headers: function() {
    return {
      "API_KEY": this.get("session.authToken"),
      "ANOTHER_HEADER": "Some header value"
    };
  }.property("session.authToken")
});

app/adapters/application.js
1 2 3 4 5 6 7 8 9 10	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ headers: function() { return { "API_KEY": this.get("session.authToken"), "ANOTHER_HEADER": "Some header value" }; }.property("session.authToken") });

In some cases, your dynamic headers may require data from some object outside of Ember's observer system (for example document.cookie). You can use the volatile function to set the property into a non-cached mode causing the headers to be recomputed with every request.

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  headers: function() {
    return {
      "API_KEY": Ember.get(document.cookie.match(/apiKey\=([^;]*)/), "1"),
      "ANOTHER_HEADER": "Some header value"
    };
  }.property().volatile()
});

app/adapters/application.js
1 2 3 4 5 6 7 8 9 10	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ headers: function() { return { "API_KEY": Ember.get(document.cookie.match(/apiKey\=([^;]*)/), "1"), "ANOTHER_HEADER": "Some header value" }; }.property().volatile() });

Show: Inherited Protected Private Deprecated

buildURL (modelName, id, snapshot, requestType, query) String

Module: ember-data

Inherited from DS.BuildURLMixin packages/ember-data/lib/adapters/build-url-mixin.js:31

modelName: String
id: (String|Array|Object); single id or array of ids or query
snapshot: (DS.Snapshot|Array); single snapshot or array of snapshots
requestType: String
query: Object; object of query parameters to send for query requests.
returns: String; url

Builds a URL for a given type and optional ID.

By default, it pluralizes the type's name (for example, 'post' becomes 'posts' and 'person' becomes 'people'). To override the pluralization see pathForType.

If an ID is specified, it adds the ID to the path generated for the type, separated by a /.

When called by RESTAdapter.findMany() the id and snapshot parameters will be arrays of ids and snapshots.

convertResourceObject (payload) Object

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/store/serializer-response.js:295

payload: Object
returns: Object; an object formatted the way DS.Store understands

This method converts a JSON-API Resource Object to a format that DS.Store understands.

TODO: This method works as an interim until DS.Store understands JSON-API.

createRecord (store, type, snapshot) Promise

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:637

store: DS.Store
type: DS.Model
snapshot: DS.Snapshot
returns: Promise; promise

Called by the store when a newly created record is saved via the save method on a model record instance.

The createRecord method serializes the record and makes an Ajax (HTTP POST) request to a URL computed by buildURL.

See serialize for information on how to customize the serialized form of a record.

deleteRecord (store, type, snapshot) Promise

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:691

store: DS.Store
type: DS.Model
snapshot: DS.Snapshot
returns: Promise; promise

Called by the store when a record is deleted.

The deleteRecord method makes an Ajax (HTTP DELETE) request to a URL computed by buildURL.

findAll (store, type, sinceToken, snapshotRecordArray) Promise

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:124

store: DS.Store
type: DS.Model
sinceToken: String
snapshotRecordArray: DS.SnapshotRecordArray
returns: Promise; promise

The findAll() method is used to retrieve all records for a given type.

Example

        
          
              app/adapters/application.js
            

          
              
              import DS from 'ember-data';

export default DS.Adapter.extend({
  findAll: function(store, type, sinceToken) {
    var url = type;
    var query = { since: sinceToken };
    return new Ember.RSVP.Promise(function(resolve, reject) {
      jQuery.getJSON(url, query).then(function(data) {
        Ember.run(null, resolve, data);
      }, function(jqXHR) {
        jqXHR.then = null; // tame jQuery's ill mannered promises
        Ember.run(null, reject, jqXHR);
      });
    });
  }
});
            

        
      

app/adapters/application.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16	import DS from 'ember-data'; export default DS.Adapter.extend({ findAll: function(store, type, sinceToken) { var url = type; var query = { since: sinceToken }; return new Ember.RSVP.Promise(function(resolve, reject) { jQuery.getJSON(url, query).then(function(data) { Ember.run(null, resolve, data); }, function(jqXHR) { jqXHR.then = null; // tame jQuery's ill mannered promises Ember.run(null, reject, jqXHR); }); }); } });

findBelongsTo (store, snapshot, url) Promise

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:602

store: DS.Store
snapshot: DS.Snapshot
url: String
returns: Promise; promise

Called by the store in order to fetch a JSON array for the unloaded records in a belongs-to relationship that were originally specified as a URL (inside of links).

For example, if your original payload looks like this:

        
              {
  "person": {
    "id": 1,
    "name": "Tom Dale",
    "links": { "group": "/people/1/group" }
  }
}

This method will be called with the parent record and /people/1/group.

The findBelongsTo method will make an Ajax (HTTP GET) request to the originally specified URL.

findHasMany (store, snapshot, url) Promise

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:566

store: DS.Store
snapshot: DS.Snapshot
url: String
returns: Promise; promise

Called by the store in order to fetch a JSON array for the unloaded records in a has-many relationship that were originally specified as a URL (inside of links).

For example, if your original payload looks like this:

        
              {
  "post": {
    "id": 1,
    "title": "Rails is omakase",
    "links": { "comments": "/posts/1/comments" }
  }
}

This method will be called with the parent record and /posts/1/comments.

The findHasMany method will make an Ajax (HTTP GET) request to the originally specified URL.

findMany (store, type, ids, snapshots) Promise

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:528

store: DS.Store
type: DS.Model
ids: Array
snapshots: Array
returns: Promise; promise

Called by the store in order to fetch several records together if coalesceFindRequests is true

For example, if the original payload looks like:

        
              {
  "id": 1,
  "title": "Rails is omakase",
  "comments": [ 1, 2, 3 ]
}

The IDs will be passed as a URL-encoded Array of IDs, in this form:

        
              ids[]=1&ids[]=2&ids[]=3

Many servers, such as Rails and PHP, will automatically convert this URL-encoded array into an Array for you on the server-side. If you want to encode the IDs, differently, just override this (one-line) method.

The findMany method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a promise for the resulting payload.

findRecord (store, type, id, snapshot) Promise

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:378

store: DS.Store
type: DS.Model
id: String
snapshot: DS.Snapshot
returns: Promise; promise

Called by the store in order to fetch the JSON for a given type and ID.

The findRecord method makes an Ajax request to a URL computed by buildURL, and returns a promise for the resulting payload.

This method performs an HTTP GET request with the id provided as part of the query string.

generateIdForRecord (store, type, inputProperties) (String|Number)

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:230

store: DS.Store
type: DS.Model; the DS.Model class of the record
inputProperties: Object; a hash of properties to set on the newly created record.
returns: (String|Number); id

If the globally unique IDs for your records should be generated on the client, implement the generateIdForRecord() method. This method will be invoked each time you create a new record, and the value returned from it will be assigned to the record's primaryKey.

Most traditional REST-like HTTP APIs will not use this method. Instead, the ID of the record will be set by the server, and your adapter will update the store with the new ID when it calls didCreateRecord(). Only implement this method if you intend to generate record IDs on the client-side.

The generateIdForRecord() method will be invoked with the requesting store as the first parameter and the newly created record as the second parameter:

        
              generateIdForRecord: function(store, inputProperties) {
  var uuid = App.generateUUIDWithStatisticallyLowOddsOfCollision();
  return uuid;
}

groupRecordsForFindMany (store, snapshots) Array

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:728

store: DS.Store
snapshots: Array
returns: Array; an array of arrays of records, each of which is to be loaded separately by `findMany`.

Organize records into groups, each of which is to be passed to separate calls to findMany.

This implementation groups together records that have the same base URL but differing ids. For example /comments/1 and /comments/2 will be grouped together because we know findMany can coalesce them together as /comments?ids[]=1&ids[]=2

It also supports urls where ids are passed as a query param, such as /comments?id=1 but not those where there is more than 1 query param such as /comments?id=2&name=David Currently only the query param of id is supported. If you need to support others, please override this or the _stripIDFromURL method.

It does not group records that have differing base urls, such as for example: /posts/1/comments/2 and /posts/2/comments/3

handleResponse (status, headers, payload) Object | DS.AdapterError

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:816

status: Number
headers: Object
payload: Object
returns: Object | DS.AdapterError; response

Takes an ajax response, and returns the json payload or an error.

By default this hook just returns the json payload passed to it. You might want to override it in two cases:

Your API might return useful results in the response headers. Response headers are passed in as the second argument.
Your API might return errors as successful responses with status code 200 and an Errors text or object. You can return a DS.InvalidError or a DS.AdapterError (or a sub class) from this hook and it will automatically reject the promise and put your record into the invalid or error state.

Returning a DS.InvalidError from this method will cause the record to transition into the invalid state and make the errors object available on the record. When returning an DS.InvalidError the store will attempt to normalize the error data returned from the server using the serializer's extractErrors method.

isInvalid (status, headers, payload) Boolean

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:869

status: Number
headers: Object
payload: Object
returns: Boolean

Default handleResponse implementation uses this hook to decide if the response is a an invalid error.

isSuccess (status, headers, payload) Boolean

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:855

status: Number
headers: Object
payload: Object
returns: Boolean

Default handleResponse implementation uses this hook to decide if the response is a success.

normalizeResponseHelper (serializer, store, modelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/store/serializer-response.js:71

serializer: DS.Serializer
store: DS.Store
modelClass: subclass of DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

This is a helper method that always returns a JSON-API Document.

If the current serializer has isNewSerializerAPI set to true this helper calls normalizeResponse instead of extract.

All the built-in serializers get isNewSerializerAPI set to true automatically if the feature flag is enabled.

pathForType (modelName) String

Module: ember-data

Inherited from DS.BuildURLMixin packages/ember-data/lib/adapters/build-url-mixin.js:293

modelName: String
returns: String; path

Determines the pathname for a given type.

By default, it pluralizes the type's name (for example, 'post' becomes 'posts' and 'person' becomes 'people').

Pathname customization

For example if you have an object LineItem with an endpoint of "/line_items/".

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  pathForType: function(modelName) {
    var decamelized = Ember.String.decamelize(modelName);
    return Ember.String.pluralize(decamelized);
  }
});

app/adapters/application.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ pathForType: function(modelName) { var decamelized = Ember.String.decamelize(modelName); return Ember.String.pluralize(decamelized); } });

pushPayload (store, payload) DS.Model|Array

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/store/serializer-response.js:222

store: DS.Store
payload: Object
returns: DS.Model|Array; one or multiple records from `data`

Push a JSON-API Document to the store.

This will push both primary data located in data and secondary data located in included (if present).

pushPayloadData (store, payload) DS.Model|Array

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/store/serializer-response.js:239

store: DS.Store
payload: Object
returns: DS.Model|Array; one or multiple records from `data`

Push the primary data of a JSON-API Document to the store.

This method only pushes the primary data located in data.

pushPayloadIncluded (store, payload) Array

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/store/serializer-response.js:263

store: DS.Store
payload: Object
returns: Array; an array containing zero or more records from `included`

Push the secondary data of a JSON-API Document to the store.

This method only pushes the secondary data located in included.

queryRecord (store, type, query) Promise

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:190

store: DS.Store
type: subclass of DS.Model
query: Object
returns: Promise; promise

The queryRecord() method is invoked when the store is asked for a single record through a query object.

In response to queryRecord() being called, you should always fetch fresh data. Once found, you can asynchronously call the store's push() method to push the record into the store.

Here is an example queryRecord implementation:

Example

        
              app/adapters/application.js
            
              import DS from 'ember-data';
import Ember from 'ember';

export default DS.Adapter.extend(DS.BuildURLMixin, {
  queryRecord: function(store, type, query) {
    var urlForQueryRecord = this.buildURL(type.modelName, null, null, 'queryRecord', query);

    return new Ember.RSVP.Promise(function(resolve, reject) {
      Ember.$.getJSON(urlForQueryRecord, query).then(function(data) {
        Ember.run(null, resolve, data);
      }, function(jqXHR) {
        jqXHR.then = null; // tame jQuery's ill mannered promises
        Ember.run(null, reject, jqXHR);
      });
    });
  }
});

app/adapters/application.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17	import DS from 'ember-data'; import Ember from 'ember'; export default DS.Adapter.extend(DS.BuildURLMixin, { queryRecord: function(store, type, query) { var urlForQueryRecord = this.buildURL(type.modelName, null, null, 'queryRecord', query); return new Ember.RSVP.Promise(function(resolve, reject) { Ember.$.getJSON(urlForQueryRecord, query).then(function(data) { Ember.run(null, resolve, data); }, function(jqXHR) { jqXHR.then = null; // tame jQuery's ill mannered promises Ember.run(null, reject, jqXHR); }); }); } });

serialize (snapshot, options) Object

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:260

snapshot: DS.Snapshot
options: Object
returns: Object; serialized snapshot

Proxies to the serializer's serialize method.

Example

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.Adapter.extend({
  createRecord: function(store, type, snapshot) {
    var data = this.serialize(snapshot, { includeId: true });
    var url = type;

    // ...
  }
});

app/adapters/application.js
1 2 3 4 5 6 7 8 9 10	import DS from 'ember-data'; export default DS.Adapter.extend({ createRecord: function(store, type, snapshot) { var data = this.serialize(snapshot, { includeId: true }); var url = type; // ... } });

shouldBackgroundReloadAll (store, snapshotRecordArray) Boolean

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:513

store: DS.Store
snapshotRecordArray: DS.SnapshotRecordArray
returns: Boolean

This method is used by the store to determine if the store should reload a record array after the store.findAll method resolves with a cached record array.

This method is only checked by the store when the store is returning a cached record array.

If this method returns true the store will re-fetch all records from the adapter.

shouldBackgroundReloadRecord (store, snapshot) Boolean

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:492

store: DS.Store
snapshot: DS.Snapshot
returns: Boolean

This method is used by the store to determine if the store should reload a record after the store.findRecord method resolves a cached record.

This method is only checked by the store when the store is returning a cached record.

If this method returns true the store will re-fetch a record from the adapter.

shouldReloadAll (store, snapshotRecordArray) Boolean

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:472

store: DS.Store
snapshotRecordArray: DS.SnapshotRecordArray
returns: Boolean

This method is used by the store to determine if the store should reload all records from the adapter when records are requested by store.findAll.

If this method returns true, the store will re-fetch all records from the adapter. If this method returns false, the store will resolve immediately using the cached record.

shouldReloadRecord (store, snapshot) Boolean

Module: ember-data

Inherited from DS.Adapter packages/ember-data/lib/system/adapter.js:454

store: DS.Store
snapshot: DS.Snapshot
returns: Boolean

This method is used by the store to determine if the store should reload a record from the adapter when a record is requested by store.findRecord.

If this method returns true, the store will re-fetch a record from the adapter. If this method returns false, the store will resolve immediately using the cached record.

sortQueryParams (obj) Object

Module: ember-data

Defined in packages/ember-data/lib/adapters/rest-adapter.js:199

obj: Object
returns: Object

By default, the RESTAdapter will send the query params sorted alphabetically to the server.

For example:

        
                store.query('posts', { sort: 'price', category: 'pets' });

will generate a requests like this /posts?category=pets&sort=price, even if the parameters were specified in a different order.

That way the generated URL will be deterministic and that simplifies caching mechanisms in the backend.

Setting sortQueryParams to a falsey value will respect the original order.

In case you want to sort the query parameters with a different criteria, set sortQueryParams to your custom sort function.

        
              app/adapters/application.js
            
              import DS from 'ember-data';

export default DS.RESTAdapter.extend({
  sortQueryParams: function(params) {
    var sortedKeys = Object.keys(params).sort().reverse();
    var len = sortedKeys.length, newParams = {};

    for (var i = 0; i < len; i++) {
      newParams[sortedKeys[i]] = params[sortedKeys[i]];
    }
    return newParams;
  }
});

app/adapters/application.js
1 2 3 4 5 6 7 8 9 10 11 12 13	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ sortQueryParams: function(params) { var sortedKeys = Object.keys(params).sort().reverse(); var len = sortedKeys.length, newParams = {}; for (var i = 0; i < len; i++) { newParams[sortedKeys[i]] = params[sortedKeys[i]]; } return newParams; } });