harry-potter-api's Introduction

Harry Potter Search API 🧙🏽‍♂️🪄

🎥 Abstract

Are you a fan of the fantastic Wizarding world of Harry Potter? This application has over 100 characters with in-depth information about them like their wands, houses, and more!

🎥 Contributors

David Kwon

🎥 Installation Instructions

Fork repository
Clone repository onto your local machine
cd into root directory of repository
Run npm install to install project dependencies
Run node server.js OR nodemon server.js to start the local server and navigate to localhost:3000

🎥 API Endpoints

Description	URL	Method	Required Properties for Request
Home	"http:localhost:3000"	GET	none
Get all characters	"http:localhost:3000/api/v1/characters"	GET	none
Get single character	"http:localhost:3000/api/v1/characters/:id"	GET	none
Update entire character	"http:localhost:3000/api/v1/characters/:id"	PUT	```json

            {                     
            name: <String>,
            gender: <String>,
            job: <String>,
            house: <String>,
            wand: <String>,
            patronus: <String>,
            species: <String>,
            bloodStatus: <String>,
            hairColor: <String>,
            eyeColor: <String>,
            loyalty: <String>,
            skills: <String>,
            birth: <String>,
            death: <String> 
            } 
            ``` |

🎥 Technologies Used

🎥 Context

🎬 Goals:
- Gain competency with Express framework and building RESTful APIs on Node.js
🎬 Wins:
- Created my own unique RESTful API
🎬 Challenges:
- It was interesting self studying different approaches on PUT/PATCH/DELETE methods as these were not covered in the curriculum!

Recommend Projects