Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An API engine for Rails. Uses active model serializers. Built to interface with Ember Data w/ Bulk commits.
Ruby JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config
lib
script
spec
.gitignore
.rspec
.travis.yml
Gemfile
Gemfile.lock
LICENSE.md
README.md
Rakefile
api_engine.gemspec

README.md

Build Status Code Climate Dependency Status

An API engine for Rails. Convention over configuration. Auto generated docs (coming soon!)

You should use this gem if:

  • You want to add an API to your Rails app in just a few lines of code
  • You don't want to spend time writing controller code for your API
  • You want an API compatible with Ember Data

Installation

  1. Add gem "api_engine", "~> 0.0.1" to your gem file
  2. Generate an initializer: rails generate api_engine:config
  3. Add mount ApiEngine::Engine => "/api" to your routes file

Configuration

By default all of your models will be exposed in a bulk REST API at /api/:model_name. To expose only certain models, use the whitelist config option:

ApiEngine.configure do |config|
  config.whitelist = [:comment] # Exposes only the 'Comment' model via the API
end

Authentication

Coming soon! There is an open issue for this

Other Gems

Looking for some other resources for creating more complex APIs? Check out these gems...

Contributing

Creating an issue is good. Sending a pull request is better.

License and Copyright

Copyright 2013 Steven Faulkner

Released under the MIT License. See LICENSE.md for full text

Bitdeli Badge

Something went wrong with that request. Please try again.