Credit to devdocs.io

angularjs 1.4

angularjs

Improve this Doc View Source $httpBackend

  1. service in module ngMockE2E

Fake HTTP backend implementation suitable for end-to-end testing or backend-less development of applications that use the $http service.

Note: For fake http backend implementation suitable for unit testing please see unit-testing $httpBackend mock.

This implementation can be used to respond with static or dynamic responses via the when api and its shortcuts (whenGET, whenPOST, etc) and optionally pass through requests to the real $httpBackend for specific requests (e.g. to interact with certain remote apis or to fetch templates from a webserver).

As opposed to unit-testing, in an end-to-end testing scenario or in scenario when an application is being developed with the real backend api replaced with a mock, it is often desirable for certain category of requests to bypass the mock and issue a real http request (e.g. to fetch templates or static files from the webserver). To configure the backend with this behavior use the passThrough request handler of when instead of respond.

Additionally, we don't want to manually have to flush mocked out requests like we do during unit testing. For this reason the e2e $httpBackend flushes mocked out requests automatically, closely simulating the behavior of the XMLHttpRequest object.

To setup the application to run with this http backend, you have to create a module that depends on the ngMockE2E and your application modules and defines the fake backend:

myAppDev = angular.module('myAppDev', ['myApp', 'ngMockE2E']);
myAppDev.run(function($httpBackend) {
  phones = [{name: 'phone1'}, {name: 'phone2'}];

  // returns the current list of phones
  $httpBackend.whenGET('/phones').respond(phones);

  // adds a new phone to the phones array
  $httpBackend.whenPOST('/phones').respond(function(method, url, data) {
    var phone = angular.fromJson(data);
    phones.push(phone);
    return [200, phone, {}];
  });
  $httpBackend.whenGET(/^\/templates\//).passThrough();
  //...
});

Afterwards, bootstrap your app with this new module.

Methods

  • when(method, url, [data], [headers]);

    Creates a new backend definition.

    Parameters

    Param Type Details
    method string

    HTTP method.

    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    data
    (optional)
    stringRegExp

    HTTP request body.

    headers
    (optional)
    Objectfunction(Object)

    HTTP headers or function that receives http header object and returns true if the headers match the current definition.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

    • respond – {function([status,] data[, headers, statusText]) | function(function(method, url, data, headers)} – The respond method takes a set of static data to be returned or a function that can return an array containing response status (number), response data (string), response headers (Object), and the text for the status (string).
    • passThrough – {function()} – Any request matching a backend definition with passThrough handler will be passed through to the real backend (an XHR request will be made to the server.)
    • Both methods return the requestHandler object for possible overrides.
  • whenGET(url, [headers]);

    Creates a new backend definition for GET requests. For more info see when().

    Parameters

    Param Type Details
    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    headers
    (optional)
    Objectfunction(Object)

    HTTP headers.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

  • whenHEAD(url, [headers]);

    Creates a new backend definition for HEAD requests. For more info see when().

    Parameters

    Param Type Details
    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    headers
    (optional)
    Objectfunction(Object)

    HTTP headers.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

  • whenDELETE(url, [headers]);

    Creates a new backend definition for DELETE requests. For more info see when().

    Parameters

    Param Type Details
    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    headers
    (optional)
    Objectfunction(Object)

    HTTP headers.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

  • whenPOST(url, [data], [headers]);

    Creates a new backend definition for POST requests. For more info see when().

    Parameters

    Param Type Details
    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    data
    (optional)
    stringRegExp

    HTTP request body.

    headers
    (optional)
    Objectfunction(Object)

    HTTP headers.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

  • whenPUT(url, [data], [headers]);

    Creates a new backend definition for PUT requests. For more info see when().

    Parameters

    Param Type Details
    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    data
    (optional)
    stringRegExp

    HTTP request body.

    headers
    (optional)
    Objectfunction(Object)

    HTTP headers.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

  • whenPATCH(url, [data], [headers]);

    Creates a new backend definition for PATCH requests. For more info see when().

    Parameters

    Param Type Details
    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    data
    (optional)
    stringRegExp

    HTTP request body.

    headers
    (optional)
    Objectfunction(Object)

    HTTP headers.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

  • whenJSONP(url);

    Creates a new backend definition for JSONP requests. For more info see when().

    Parameters

    Param Type Details
    url stringRegExpfunction(string)

    HTTP url or function that receives a url and returns true if the url matches the current definition.

    Returns

    requestHandler

    Returns an object with respond and passThrough methods that control how a matched request is handled. You can save this object for later use and invoke respond or passThrough again in order to change how a matched request is handled.

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.4.14/docs/api/ngMockE2E/service/$httpBackend