/rails-api

Sample project for using Rails as an API

Primary LanguageRuby

Rails API Sample

Sample music API using Rails

Technology Stack

Domain

The following domain is used to illustrate key principles and maintain focus on building APIs:

  • Artist
  • Albums
  • Songs

An artist has many albums. An album has many songs.

Quick links include:

  • featured (artists)
  • recent releases (albums)
  • hot (albums, songs)
  • top (artists, albums, songs)

Goals

  • Conventions
  • Layered Architecture (MVC)
  • Validations
  • Tests
  • Shared examples
  • Generators
  • REST
  • JSON representation
  • Routing
  • Managing complex queries (scopes)
  • Support for different environments
  • Logging
  • Authentication
  • Caching
  • Pagination

Future Ideas