johan-- / rails-api-example

An example versioned Rails API

Rails Versioned API Example

This is an example of establishing API versioning on top of an existing, unversioned Rails API.

Getting Started

1. Clone the repo

   $ git clone [email protected]:iamvery/rails-api-example.git
   $ cd rails-api-example
   

2. Install dependencies

   $ bundle install
   

3. Watch the specs pass

   $ bin/rspec
   ... 0 failures
   

Initial implementation

The initial, unversioned implementation is at https://github.com/iamvery/rails-api-example/tree/initial-api-implementation. From there the commits incrementally add versioning to the API using HTTP accept headers with a vendor internet media type.

What's interesting?

There are few suite spots in this repo (see what I did there?)

• Articles v1 controller
• Articles v2 controller
• Endpoints specs
• Routes
• API Route Constraint