Rails REST Framework Documentation #

Gem Version Build Status Coverage Status Maintainability

A framework for DRY RESTful APIs in Ruby on Rails.

The Problem: Building controllers for APIs usually involves writing a lot of redundant CRUD logic, and routing them can be obnoxious. Building and maintaining features like ordering, filtering, and pagination can be tedious.

The Solution: This framework implements browsable API responses, CRUD actions for your models, and features like ordering/filtering/pagination, so you can focus on building awesome APIs.

Website/Guide: https://rails-rest-framework.com

Source: https://github.com/gregschmit/rails-rest-framework

YARD Docs: https://rubydoc.info/gems/rest_framework

Installation #

Add this line to your application’s Gemfile:

gem 'rest_framework'

And then execute:

$ bundle install

Or install it yourself with:

$ gem install rest_framework

Development/Testing #

After you clone the repository, cd’ing into the directory should create a new gemset if you are using RVM. Then run bundle install to install the appropriate gems.

To run the test suite:

$ rails test

The top-level bin/rails proxies all Rails commands to the test project, so you can operate it via the usual commands. Ensure you run rails db:setup before running rails server or rails console.