elletownsend / fantasy-api

Node.js & Express API Project

Home Page:https://the-fantasy-api.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Fantasy API

Node JS & Express API project.

Routes

  • api/v1/movies/harry-potter/ -> Get All Harry Potter Movies

  • api/v1/movies/harry-potter/:id -> Get Harry Potter Movie by Id

  • api/v1/movies/harry-potter?q=<search_term> -> Search for a Harry Potter Movie by title

  • api/v1/characters/harry-potter/ -> Get All Harry Potter Characters

  • api/v1/characters/harry-potter/:id -> Get Harry Potter Character by Id

  • api/v1/characters/harry-potter?q=<search_term> -> Search for a Harry Potter Character by name

  • api/v1/movies/star-wars/ -> Get All Star Wars Movies

  • api/v1/movies/star-wars/:id -> Get Star Wars Movie by Id

  • api/v1/movies/star-wars?q=<search_term> -> Search for a Star Wars Movie by title

  • api/v1/characters/star-wars/ -> Get All Star Wars Characters

  • api/v1/characters/star-wars/:id -> Get Star Wars Character by Id

  • api/v1/characters/star-wars?q=<search_term> -> Search for a Star Wars Character by name

Scripts

  • npm start -> Run development server with hot reloading (using nodemon)
  • npm test -> Runs tests (currently 6/6 passing)

Tech stack

  • Node.js
  • Express
  • Morgan (logger middleware)
  • JSON (for data)
  • Testing with Mocha, Chai and Chai-http

To Do:

  • Improved API responses for usability
  • Improved endpoint validation
  • Lord of the rings!
  • Improved filtering & Searching

Credits

Harry Potter Data - Gulsah Demiryurek Star Wars Data - Joe Young Lord of The Rings Data - Paul Mooney

About

Node.js & Express API Project

https://the-fantasy-api.herokuapp.com/

License:MIT License


Languages

Language:JavaScript 78.4%Language:HTML 19.8%Language:CSS 1.8%