Skip to content

skut21x-ga/mcu-api

Repository files navigation

Marvel Cinematic Universe (MCU) API

This is a Marvel Cinematic Universe (MCU) API server that provides information on character's in Marvel's (https://www.marvel.com) movies and tv shows. For this API, there is no auth key needed. Swagger Documentation is available in the root directory in JSON format and PDF.

How to install dependencies and Run locally:

  1. Run 'npm install' in mcu-api root folder
  2. Run "node seed.js" in lib/db folder
  3. Run "node index.js" in lib folder (this will start the server listening on port 8080)

API Can be run server-side at:

API Utilizes:

  • Mongoose
  • Node-Fetch
  • Body-Parser
  • Express
  • Heroku
  • MongoDB / Atlas

Routes Utilized:

  • POST ("/") to create a new character in db

    • For example, the following example code can go into Body as RAW input (JSON Format) for a POST to "http://localhost:3000/".
 {"category": "Hero",
       "real_name": "Scott Kutler",
       "alias": "Super Scott",
       "species": "Human",
       "affiliation": "S.H.I.E.L.D."}

  • PUT ("/name/:name") to search for a character by full name and edit that character ()
 {   "alias": "Super Jensen",
       "species": "Inhuman"     }

  • DELETE ("/name/:name") to search for a character by full name and delete that character

Available Parameters:

  • Real Name (ie. "Stephen Vincent Strange", "Jensen")
  • Category (ie "Hero", "Villain"),
  • Species (ie. "Human", "Inhuman"),
  • Affiliation (ie. "S.H.I.E.L.D.", "HYDRA")

Resources Used

Kaggle's MCU Characters CSV from: https://www.kaggle.com/apriandito/mcu-characters
Original dataset from Kamis Data Program - R Indonesia: https://github.com/indo-r/kamisdata. All characters are owned and copywrite by Marvel.
Utilized a CSV to JSON converter to convert to JSON from the Kaggle CSV dataset: https://csvjson.com/csv2json
Utilized Swagger to create Swagger JSON & YAML (http://swagger.io/)

About

Marvel Cinematic Universe (MCU) API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published