What else were we going to do?
We've created an API Web Application related to the fantasy world portrayed in the "Game of Thrones" telivision series. The intended use for our project is to have the ability to retreive specific Game of Thrones information from a user's request. The client will send a request specifying which endpoint to be used. The API then takes this request to the server. From the server, a response containing the desired data is returned. The data is then converted into a readable response and will be displayed on the user's interface. This API can be used by anyone with a need for specified Game of Thrones information, who would like to shorten their research time.
- Visual Studio Code - Development Environment
- Postman - API Client
- Github - Host/Collaboration Service
- Entity Framework
- Owin
To get a local copy of the Game of Thrones database up and running follow these simple steps.
You will need a copy of Visual Studio 2019 as well as Postman to utilize the API's endpoints easily. Follow the links below should you do not have the free software installed already.
1. Clone the Solution from GitHub using the link the solution below. After navigating there and cloning open using Visual Studio.
Clone the API for Visual Studios Here
2. Be sure to restore the NuGet Packages for the GoTAPI solution
Right click on your opened Solution 'GoTAPI' and select "restore NuGet Packages" (and then bring in using statements if needed).
3.Run the Solution and open Postman to utilize the database
With a running solution and Postman get features ready to be utilized there are a myriad of different endpoints, most importantly 9 GET endpoints for reference in any Game of Thrones lookup.
This API is meant to be used as a resource that cross-cordinates Houses, Characters, Affilitions, and Episodes in various ways to help broaden an understanding of HBO's hit series Game of Thrones.
When researching we can get a list, in this case of characters, with Id numbers as seen below. Let's note Tyrion's Id.
Then by adding a forward slash and the Id number of Tyrion we can bring up Tyrion's corresponding detail page.
These details pages are fairly extensive as we combine 4 independent classes using 3 joining tables to present a character's; Id, Name, wheter they are alive, their episode of death, House, Gender, Actor, Cause of Death, Episodes, and Affiliations.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
- Konrad Haight - konradhaight@gmail.com
- Marshall Davis - marmadav@gmail.com
- Jack McCoy - jackmccoy34@gmail.com
Project Link: https://github.com/kahaight/GameOfThronesAPI