ember-web-api
v1.0.1
Published
Ember CLI Addon for connecting Ember Data to ASP.NET Web API.
Downloads
3
Maintainers
Readme
Ember - Web API
This project is simply a Serializer and Adapter for working with Microsoft ASP.NET Web API endpoints.
Usage
Prerequisites
Currently, the Serializer assumes that your Web API endpoint's response will contain camelCased
property names rather than the default .NET PascalCase
names.
Luckily, Newtonsoft's JSON.NET makes this relatively trivial and it's already the default serializer, so you're all set. You just need to add the following code to your API's startup configuration:
var formatters = GlobalConfiguration.Configuration.Formatters;
var jsonFormatter = formatters.JsonFormatter;
var settings = jsonFormatter.SerializerSettings;
settings.Formatting = Formatting.Indented;
settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
Installation
Installation is a breeze. You just need to ensure that you install the proper version of Ember Web API for your version of Ember Data.
If you're using Ember Data 2.0+, you're in luck! You can just install the latest stable release:
ember install ember-web-api
For versions between 1.13.0 and 1.13.15, you should be on the 0.0.7
release:
ember install [email protected]
If you're using an older version of Ember, you'll have to use one of the older releases:
ember install [email protected]
Usage
First, generate your application Adapter:
ember generate adapter application
And then modify your code to extend the Web API Adapter instead:
import WebApiAdapter from 'ember-web-api/adapters/web-api';
export default WebApiAdapter.extend({
});
Now do the same for the Serializer:
ember generate serializer application
import WebApiSerializer from 'ember-web-api/serializers/web-api';
export default WebApiSerializer.extend({
});
That's it! Your application should now be configured to consume Web API endpoints.
Extending and Configuring
The Web API Adapter and Serializer both extend Ember Data's DS.RESTAdapter and DS.RESTSerializer and accept the same options.
Contributing
Installation
git clone
this repositorynpm install
bower install
Running
ember server
- Visit your app at http://localhost:4200.
Running Tests
ember test
ember test --server
Building
ember build
For more information on using ember-cli, visit http://www.ember-cli.com/.