https://github.com/samrap/learn-rails-basic-rest-api
A basic RESTful API built to become more familiar with Rails
https://github.com/samrap/learn-rails-basic-rest-api
Last synced: 8 months ago
JSON representation
A basic RESTful API built to become more familiar with Rails
- Host: GitHub
- URL: https://github.com/samrap/learn-rails-basic-rest-api
- Owner: samrap
- Created: 2018-06-13T03:43:13.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-13T04:12:03.000Z (about 8 years ago)
- Last Synced: 2025-02-02T21:29:13.203Z (over 1 year ago)
- Language: Ruby
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A basic RESTful API written in Ruby
The purpose of this repository is to build a RESTful API in Rails as practice for becoming more familiar with Ruby and the Rails framework in particular.
## The Application
The API will provide basic CRUD functionality for managing an online library of books. Routes should be protected with OAUTH and the API should be built using TDD.
## Project Goals
The following goals should be achieved upon completion of this API:
- Take the Rails "Getting Started" guide to the next level by using the knowledge obtained [by following the guide](https://github.com/samrap/rails-blog) to create a more robust project.
- Establish a better understanding of the framework end-to-end
- Become familiar with the Minitest testing framework
- Discover some "rubyisms" encouraged by Rails
- Become more well-rounded in Ruby itself
Since both Ruby and Rails are brand-new to me at this point, I decided to use Rails as an accelerated introduction to Rails. While I understand jumping straight into a framework before learning the language can have negative effects, I feel it is the best approach for learning Ruby best-practices, especially with the various tools and conventions of a large project.