Fake HTTP backend implementation suitable for end-to-end testing or backend-less development of applications that use the $http service.
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:
var myAppDev = angular.module('myAppDev', ['myApp', 'ngMockE2E']); myAppDev.run(function($httpBackend) { var 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(); // Requests for templates are handled by the real server //... });
Afterwards, bootstrap your app with this new module.
Creates a new backend definition.
Param | Type | Details |
---|---|---|
method | string | HTTP method. |
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
data (optional) | string RegExp function(string) | HTTP request body or function that receives data string and returns true if the data is as expected. |
headers (optional) | Object function(Object) | HTTP headers or function that receives http header object and returns true if the headers match the current definition. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with
|
Creates a new backend definition for GET requests. For more info see when()
.
Param | Type | Details |
---|---|---|
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
headers (optional) | Object function(Object) | HTTP headers. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with |
Creates a new backend definition for HEAD requests. For more info see when()
.
Param | Type | Details |
---|---|---|
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
headers (optional) | Object function(Object) | HTTP headers. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with |
Creates a new backend definition for DELETE requests. For more info see when()
.
Param | Type | Details |
---|---|---|
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
headers (optional) | Object function(Object) | HTTP headers. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with |
Creates a new backend definition for POST requests. For more info see when()
.
Param | Type | Details |
---|---|---|
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
data (optional) | string RegExp function(string) | HTTP request body or function that receives data string and returns true if the data is as expected. |
headers (optional) | Object function(Object) | HTTP headers. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with |
Creates a new backend definition for PUT requests. For more info see when()
.
Param | Type | Details |
---|---|---|
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
data (optional) | string RegExp function(string) | HTTP request body or function that receives data string and returns true if the data is as expected. |
headers (optional) | Object function(Object) | HTTP headers. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with |
Creates a new backend definition for PATCH requests. For more info see when()
.
Param | Type | Details |
---|---|---|
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
data (optional) | string RegExp function(string) | HTTP request body or function that receives data string and returns true if the data is as expected. |
headers (optional) | Object function(Object) | HTTP headers. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with |
Creates a new backend definition for JSONP requests. For more info see when()
.
Param | Type | Details |
---|---|---|
url | string RegExp function(string)= | HTTP url or function that receives a url and returns true if the url matches the current definition. |
keys (optional) | Array | Array of keys to assign to regex matches in request url described on $httpBackend mock. |
requestHandler |
Returns an object with |
Creates a new backend definition that compares only with the requested route.
Param | Type | Details |
---|---|---|
method | string | HTTP method. |
url | string | HTTP url string that supports colon param matching. |
requestHandler |
Returns an object with |
This method can be used to change which mocked responses $httpBackend
returns, when defining them with $httpBackend.when() (and shortcut methods). By default, $httpBackend
returns the first definition that matches. When setting $http.matchLatestDefinitionEnabled(true)
, it will use the last response that matches, i.e. the one that was added last.
hb.when('GET', '/url1').respond(200, 'content', {}); hb.when('GET', '/url1').respond(201, 'another', {}); hb('GET', '/url1'); // receives "content" $http.matchLatestDefinitionEnabled(true) hb('GET', '/url1'); // receives "another" hb.when('GET', '/url1').respond(201, 'onemore', {}); hb('GET', '/url1'); // receives "onemore"
This is useful if a you have a default response that is overriden inside specific tests.
Note that different from config methods on providers, matchLatestDefinitionEnabled()
can be changed even when the application is already running.
Param | Type | Details |
---|---|---|
value (optional) | Boolean | value to set, either |
$httpBackend Boolean
|
self when used as a setter, and the current value when used as a getter |
© 2010–2020 Google, Inc.
Licensed under the Creative Commons Attribution License 3.0.
https://code.angularjs.org/1.8.2/docs/api/ngMockE2E/service/$httpBackend