Awesome Ruby API

A collection of awesome libraries, tools, frameworks and software to create beautiful APIs using Ruby

Inspired by the awesome-ruby

Sharing, suggestions and contributions are always welcome! just use the following format:

[LIBRARY](LINK) - DESCRIPTION.

Design Guides

• http-api-design - HTTP API design guide extracted from work on the Heroku Platform API.

Documentation

• Aglio - An API Blueprint renderer.
• Apipie - Rails API documentation and display tool using Ruby syntax.
• grape-swagger - Add swagger compliant documentation to your Grape API.
• grape-swagger-rails - Integration swagger to grape in rails.
• swagger-blocks - Define and serve live-updating Swagger JSON for Ruby apps.
• swagger-docs - Define and serve live-updating Swagger JSON for Ruby apps.
• Slate - Slate helps you create beautiful API documentation.
• rspec_api_documentation - RSpec API Doc Generator.

Frameworks

• Grape - An opinionated micro-framework for creating REST-like APIs in Ruby.
• Rails::API - Rails for API only applications.
• GraphQL - GraphQL is a query language for your API. graphql-ruby is ruby implementation of GraphQL.

Testing

• Airborne - RSpec driven API testing framework.
• api_taster - A quick and easy way to visually test your Rails application's AP.
• stubb - Specify REST API stubs using your file system.
• lurker - Generates API schemas, validates code against them and creates a handy web interface for testing the API.
• minitest-reporters - Extend Minitest through simple hooks.

Serialization

• ActiveModel::Serializer - ActiveModel::Serializer brings convention over configuration to your JSON generation.
• ROAR - a framework for parsing and rendering REST documents.
• Jbuilder - gives you a simple DSL for declaring JSON structures that beats massaging giant hash structures.
• RABL - General ruby templating with json, bson, xml, plist and msgpack support.
• acts_as_api - makes creating XML/JSON responses in Rails easy and fun.

Middleware

• Rack::Cors - Rack::Cors provides support for Cross-Origin Resource Sharing (CORS) for Rack compatible web applications.

Versions

• Version Cake - An unobtrusive way to version APIs in your Rails app.
• versionist - A plugin for versioning Rails based RESTful APIs.

Videos/Talks

• Building fast, testable and sane APIs with rails.
• How we got max speed for JSON processing in a Rails API app.
• Rapidly Mapping JSON/XML API Schemas in Ruby.
• Building Your API for Longevity/
• Building REST API with grape.
• Building a web API with Ruby on Rails.
• Rails APIs: The Next Generation.

Articles

• Best Practices for Designing a Pragmatic RESTful API
• Building a RESTful API in a Rails Application
• Creating a Simple API with Rails
• Beginners guide to creating a REST API
• Producing Documentation for Your Rails API
• Why Use Rails for JSON APIs?