https://github.com/philmccarthy/rails-api
A JSON API that serves up REST and business intelligence endpoints.
https://github.com/philmccarthy/rails-api
json-api postgresql rails ruby
Last synced: 4 months ago
JSON representation
A JSON API that serves up REST and business intelligence endpoints.
- Host: GitHub
- URL: https://github.com/philmccarthy/rails-api
- Owner: philmccarthy
- Created: 2021-02-18T15:35:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-19T20:35:03.000Z (almost 5 years ago)
- Last Synced: 2025-04-15T07:34:50.717Z (8 months ago)
- Topics: json-api, postgresql, rails, ruby
- Language: Ruby
- Homepage:
- Size: 676 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![LinkedIn][linkedin-shield]][linkedin-url]
Table of Contents
## About The Project
This Rails-backed JSON API was built in 6 days while I was in Mod 3 of [Turing School's](https://turing.io) Backend Engineering program.
Areas of exploration and learning on this project included:
* Expose an API
* Use serializers to format JSON responses
* Test API exposure with RSpec and Postman
* Compose advanced ActiveRecord queries to analyze information stored in PostgreSQL database
* Write SQL statements without the assistance of an ORM
* Implement json:api standards
* Add custom error responses for invalid API requests
### Built With
* [Ruby on Rails](https://rubyonrails.org/)
* [PostgreSQL](https://www.postgresql.org/)
* [Postman](https://www.postman.com/)
## Getting Started
1. Clone this repo
2. Install gem packages: `bundle`
3. Setup the database. A pgdump is included in `./db` to seed the database
`rails db:{create,migrate,seed}`
4. Run the RSpec test suite: `bundle exec rspec`
5. Start your local server: `rails s`
A Postman test suite also exists to test the endpoints served via localhost!
- Download the [Postman Collection](https://www.getpostman.com/collections/f05c0b0f67b6dfc23a65) JSON file _(right click the link and 'save as')_
- In Postman, in the top left corner, click on the 'Import' button, and drag the downloaded JSON file over the interface or use the file selector to locate the file on your operating system. Click 'Import' to continue
- In the top left corner of the Postman interface, you’ll see a 'Runner' button. Click that and a new Postman window will appear. From here, you can select 'Rails API (by Phil McCarthy)' from the list of 'All Collections'
### Prerequisites
* Ruby 2.5.3
* Rails 5.2.4
## ReST Endpoints
### Get All Merchants
Optional Parameters: `?per_page` (defaults to 20 results) and `?page`.
```
GET /api/v1/merchants?per_page=x&page=x
```
### Get One Merchant
````
GET /api/v1/merchants/:id
````
### Get a Merchant's Items
```
GET /api/v1/merchants/:id/items
```
### Get All Items
Optional Parameters: `?per_page` (defaults to 20 results) and `?page`.
```
GET /api/v1/items?per_page=x&page=x
```
### Get One Item
```
GET /api/v1/items/:id
```
### Get an Item's Merchant
```
GET /api/v1/items/:id/merchant
```
### Update One Item
```
PATCH /api/v1/items/:id
```
Item attributes:
```json
{
"name": "value1",
"description": "value2",
"unit_price": 100.99,
"merchant_id": 14
}
```
### Create One Item
```
POST /api/v1/items/
```
Create item body format:
```json
{
"name": "value1",
"description": "value2",
"unit_price": 100.99,
"merchant_id": 14
}
```
### Delete One Item
```
DELETE /api/v1/items/:id
```
## Non-ReST Endpoints
### Find All Merchants by Fragment
Required Parameter: `?name`.
```
GET /api/v1/merchants/find_all?name=x
```
### Find One Item by Fragment
Parameter(s): `?name`, `min_price` and `max_price`.
- At least one parameter is required
- Name _cannot_ be combined with either/both price parameters
- Minimum price and maximum price _can_ be used alone or together to query a price range
```
GET /api/v1/items/find?name=x OR ?min_price=x&max_price=y
```
### Get Merchants with Most Revenue
Required Parameter: `?quantity` is required
```
GET /api/v1/revenue/merchants?quantity=x
```
### Get Merchants who Sold Most Items
Optional Parameter: `?quantity` is _not_ required for this query. Defaults to 5 results.
```
GET /api/v1/merchants/most_items?quantity=
```
### Get Revenue of a Single Merchant
```
GET /api/v1/revenue/merchants/:id
```
### Get Items with Most Revenue
Optional Parameter: `?quantity` is _not_ required. Defaults to 10 results.
```
GET /api/v1/revenue/items?quantity=x
```
### Get Potential Revenue of Unshipped Invoices
Optional Parameter: `?quantity` is _not_ required. Defaults to 10 results.
```
GET /api/v1/revenue/unshipped?quantity=x
```
## Contact
Phil McCarthy — [LinkedIn](https://linkedin.com/in/pjmcc) — [philmccarthy.dev](https://philmccarthy.dev)
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/pjmcc