Very simple Backend for Angular 2

Demo

https://llafuente.github.io/ng2-vs-backend/demo/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

Module to create Mock API Backends for Angular 2, and if there is no handler found do a XHR.

Installation

Install through npm:

npm install --save ng2-vs-backend

Import VSBackendModule in your module

1import {NgModule} from '@angular/core';
2import {BackendService} from './backendservice';
3import {VSBackendModule} from 'ng2-vs-backend';
4
5@NgModule({
6  imports: [VSBackendModule],
7  providers: [
8    BackendService, // this extends BackendBaseService
9  ]
10})
11export class YourModule {
12  constructor(backendService: BackendService) {
13    backendService.init(); // initialize now!
14  }
15}

Extend BackendBaseService with your API declaration.

1import {BackendBaseService, ParsedRequest} from 'ng2-vs-backend';
2import {Injectable} from '@angular/core';
3import {MockBackend} from '@angular/http/testing';
4import {
5  BaseRequestOptions,
6  ResponseOptions,
7  Headers,
8  XHRBackend,
9  RequestOptions,
10} from '@angular/http';
11
12@Injectable()
13export class BackendService extends BackendBaseService {
14  constructor(
15    public backend: MockBackend,
16    public options: BaseRequestOptions,
17    public realBackend: XHRBackend
18  ) {
19    super(backend, options, realBackend);
20  }
21
22  init(): void {
23    super.init();
24    // just return a value
25    let countries: any[] = [
26      {id: 1, label: 'Spain'},
27      {id: 2, label: 'France'},
28    ];
29    this.addValue('GET', '/api/v1/countries', countries);
30
31    this.addValuePaginated('GET', '/api/v1/countries2', countries);
32
33    // handle request yourself, for example to update a country
34    backendService.addListener('POST', /\/api\/v1\/country\/(.*)/, (p: ParsedRequest, matches: string[]) => {
35      // matches is the result of the RegExp sent
36      let id: number = parseInt(matches[1], 10);
37
38      countries[id].label = body.label;
39
40      return new ResponseOptions({
41        status: 204
42      });
43    });
44  }
45}
46

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/dist/umd/ng2-vs-backend/ng2-vs-backend.js"></script>
<script>
    // everything is exported VSBackend namespace
</script>

Documentation

All documentation is auto-generated from the source via typedoc and can be viewed here: https://llafuente.github.io/ng2-vs-backend/docs/

Development

Prepare your environment

• Install Node.js and NPM (should come with)
• Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

• Bump the version in package.json (once the module hits 1.0 this will become automatic)

1npm run release

License

MIT