Skip to content

marcocebrian55/simpsons-rest-api

 
 

Repository files navigation

The Simpsons REST API 🍩

REST API built with Flask and Python to manage characters and locations from The Simpsons universe, including a favorites system per user.

Technologies

  • Python / Flask
  • SQLAlchemy (ORM)
  • PostgreSQL
  • Flask-Migrate
  • Flask-CORS
  • Blueprint Architecture

Endpoints

Users

Method Route Description
GET /api/users Get all users
GET /api/users/ Get user by ID
POST /api/users Create a new user

Characters

Method Route Description
GET /api/characters Get all characters
POST /api/characters Create a new character

Locations

Method Route Description
GET /api/locations Get all locations
POST /api/locations Create a new location

Favorites

Method Route Description
POST /api/favorite/character/<char_id>/user/<user_id> Add character to favorites
DELETE /api/favorite/character/<char_id>/user/<user_id> Remove character from favorites
POST /api/favorite/location/<locs_id>/user/<user_id> Add location to favorites
DELETE /api/favorite/location/<locs_id>/user/<user_id> Remove location from favorites

Local Installation

  1. Clone the repository
  2. Install dependencies: pipenv install
  3. Create the database and run migrations: pipenv run migrate && pipenv run upgrade
  4. Start the server: pipenv run start

Author

Marco Cebrian — @marcocebrian55

About

Start a REST API's using Flask in 30 sec. One-click deploy to Heroku Server (free) & integrated with Gitpod.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 89.8%
  • Dockerfile 5.3%
  • Mako 2.4%
  • Shell 2.2%
  • Procfile 0.3%