restaurelia v1.0.0-alpha.3

REST-Aurelia

This library is part of the Aurelia platform and contains a lightweight, extensible services to handle Restful Resources properly and easily

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions, please join our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

##Usage ###Configuration This is all you need to start whith your defined api.

aurelia.use
  ...
  .plugin('restaurelia', config => {

    // Add hosts
		config.addApi('my-api', {
    	url: 'http://localhost:3030',
    	headers: {
      	'Accept': 'application/json'
      }
    });
  })
	...

###Define your API-Service First import the library:

import {inject} from 'aurelia-framework';
import {RESTService, api} from 'restaurelia';

Than there are 2 ways to describe your api servcie.

// For the default api or if there is only one, the endpoint is enough
@api('/pets')
export class MyService extends RESTService {

}

// For multiple apis the name and enpoint are important. Moreover,
// headers can also be defined for this service
@api({
	name: 'my-api',
	endpoint: '/pets',
	headers: {
		'Content-Type': 'application/json'
	}
})
export class MyService extends RESTService {

	// Besides the applied methods(see below), custom methods can also be added
	customMethod() {
		return this.request(path, options);
	}

}

####Request method params

• path: string - has the url to your endpoint
• options: Object
  • method: string - like GET, POST, PUT, DELETE
  • body: Object|string - Can be a simple string or a json-object
  • query: Object - these are the query-params
  • headers: Object - this overwrites all the other default headers

###Service methods These servcie methods will be available if you attacht the annotation @api(...)

// GET - Gets a list of the main entity
find(query, headers) => Promise<T>

// GET - Used to get a single entity
get(id, query, headers) => Promise<T>

// POST - Creates a new entity
create(data, query, headers) => Promise<T>

// PUT - Updates an entity
update(id, data, query, headers) => Promise<T>

// DELETE - Deletes the given entity
remove(id, query, headers) => Promise<void>

Params

• id: string - identifier of the entity
• data: Object|string - can be a simple string or a json-object
• query: Object - these are the query-params
• headers: Object - this overwrites all the other default headers

Platform Support

This library can be used in the browser as well as on the server.

Building The Code

To build the code, follow these steps.

1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.

2. From the project folder, execute the following command:

   npm install

3. Ensure that Gulp is installed. If you need to install it, use the following command:

   npm install -g gulp

4. To build the code, you can now run:

   gulp build

5. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

6. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:

   npm install -g karma-cli

2. Ensure that jspm is installed. If you need to install it, use the following commnand:

   npm install -g jspm

3. Install the client-side dependencies with jspm:

   jspm install

4. You can now run the tests with this command:

   karma start