Skip to content

An API engine for Rails. Very early stage. Don't use this yet

License

Notifications You must be signed in to change notification settings

zfoster/api_engine

 
 

Repository files navigation

Build Status Code Climate Dependency Status

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

Not ready for public consumption. Massive security holes still exist

Installation

  1. Add gem 'api_engine', github: "southpolesteve/api_engine" to your gem file

  2. Add mount ApiEngine::Engine => "/api" to your routes file

Configuration

There is no configuration... yet. All of your models will be exposed in a REST API at /api/:model_name. This is probably a massive security risk for any non-trivial application. You have been warned

Other Gems

https://github.com/intridea/grape https://github.com/polleverywhere/cerealizer https://github.com/apotonick/roar

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

About

An API engine for Rails. Very early stage. Don't use this yet

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 94.7%
  • JavaScript 5.3%