Table of Contents
History Maps is a backend Ruby on Rails project that calls multiple API's in order to provide a JSON package for our History Maps FE to consume.
The purpose of this project is to build an efficient API to streamline our Frontends consumption of information.
We have many great thoughts for our project, but if you would like to contribute, feel free to reach out to any of the contributors on GitHub! Find our contact information below!!
If you have experience with consuming APIs, please see then endpoints below and feel free to experiment with everything we provide!
If you are new to APIs, the endpoints provided below will return JSON information for you to use on your website. By getting familiar with how API information is packaged, you will find multitudes of information to consume! ENJOY!!!!
GET '/api/v1/users'
- Routes to users#index
GET '/api/v1/users/:id'
- Routes to users#show
POST '/api/v1/users/register'
- Routes to users#create
GET '/api/v1/users/:id/favorites'
- Routes to favorites#index
POST '/api/v1/users/:id/favorites'
- Routes to favorites#create
- Example Json Result:
GET '/api/v1/search'
- Routes to location_search#show
- params:
location
- params:
- Example Json Result:
GET '/api/v1/results'
- Routes to results#index
- Example Json Result:
- Example Json Result From Library of Congress:
GET '/api/v1/results/:id'
- Routes to results#show
- Example Json Result:
- Example Json Result From Library of Congress:
Backend
Frontend
Tables
- Users
has_many: favorites
- Favorites
belongs_to: user
Zac Hazelwood
GitHub: @ZacHazelwood
Oscar Santos
GitHub: @Oscar-Santos
Luke Pascale
GitHub: @enalihai
Clay Ash
GitHub: @ClayAsh
Matthew Deming
GitHub: @Deming-Matt
Colin Reinhart
GitHub: @ColinReinhart