Home

Introduction

The wiki section of this repo is a guide for using the ember-jsonapi-resources addon. The test application code is referenced as a practical example to using this lightweight data persistence library for an Ember.js App build with Ember CLI that communicates with an API following the JSON API 1.0 specification.

• For general info about the project see the README
• And for the backstory: My Battle with Data Persistence in Ember Apps

About the project

Ember JSONAPI Resources is a library for data persistence that is a stand-alone solution. Simply install the addon then use ember generate resource <name> to create the objects your application that will persist data to the API server which implements the JSON API 1.0 specification.

Getting Started

Read up on the JSON API format before you get started with this addon. The concepts of a "resource" are leaned on heavily for the objects provided in this library.

The aim of this data persistence solution (for an Ember.js application) is to closely resemble the representation of your resource in JSON - both in the Ember.js application and in the requests to your application server.

You will need a backend that implements the JSON API 1.0 specification. The JSONAPI::Resources gem is the inspiration for this project, and does a great job of bootstrapping an API server using Ruby on Rails.

Base Prototypes

• Resource
• Store Service
• Resource Services
• Adapter
• Serializer
• Cache Mixin
• Authorization Mixin
• Fetch Mixin
• Transforms Mixin

Tools

• Resource Generator

Configuration

• Config

Cookbooks

• [Creating a New Resource](Creating a New Resource)
• [Buffering Changes](Buffering Changes)
• Custom HTTP Authorization
• Singleton Resource