Giter VIP home page Giter VIP logo

ember-web-api's Introduction

Ember - Web API

Ember Observer Score npm version Travis CI Status codecov.io

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 repository
  • npm install
  • bower install

Running

Running Tests

  • ember test
  • ember test --server

Building

  • ember build

For more information on using ember-cli, visit http://www.ember-cli.com/.

ember-web-api's People

Contributors

crshoverride avatar danshapir avatar ember-tomster avatar osmanorhan avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.