Sha256: 23a7e40625949249e21b650e1be741ce1571145f59630be3be1c2ceb8c7c87ed

Contents?: true

Size: 1.25 KB

Versions: 1

Compression:

Stored size: 1.25 KB

Contents

# Æpic is for your epic APIs

Æpic gives you ability to easily add standards-based ([JSON-API][] and [JSON-LD][]) [API][] for
your existing [RESTful][REST] controllers.

## Installation

Add this line to your application's Gemfile:

    gem 'aepic'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install aepic

## Usage

TODO: Write usage instructions here

## Roadmap

* TODO: Provide similar Atom-based XML representation
* TODO: Provide [WADL][]

## Ideas

* TODO: Provide [Swagger-compatible][Swagger] API description
* TODO: Provide [RSDL][]

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

[JSON-API]: http://jsonapi.org/
[JSON-LD]: http://json-ld.org/
[REST]: http://en.wikipedia.org/wiki/Representational_state_transfer
[API]: http://en.wikipedia.org/wiki/Application_programming_interface
[WADL]: http://en.wikipedia.org/wiki/WADL
[RSDL]: http://en.wikipedia.org/wiki/RSDL
[Swagger]: https://developers.helloreverb.com/swagger/


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/alsemyonov/aepic/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
aepic-0.0.4 README.md