Table of contents
This fan-made API was created as a passion project. I really enjoy anime and one of my recent favorites has been My Hero Academia, I decided I wanted to create something for it and for it's fan base so I decided to create this API.
To get a local copy up and running follow these simple example steps.
To use this project you will need a node package manager installed. Visit the npm documentation for a more detailed guide.
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/pattisoj/my-hero-academia-api.git
- Install NPM packages
npm install
- Run the api locally
NOTE - When running locally this API will use
npm start
http://localhost:3000/. If you need to change this for any reason the port can be found in.bin/www.js. Do not commit any port changes on a pull request.
This space will be updated alongside the development of the API.
Requests can be made with curl or other helper libraries by following regular REST calls. For example, here is how to GET the all of the character data:
curl https://myheroacademia-api.onrender.com/characters
Calling this resource will respond with an object with the following structure:
{"students" : [
{
"id": "1",
"name": "Izuku Midoriya",
"name_japanese": "緑谷 出久",
"other_names": ["Deku"],
"quirk": "One for All",
"quirk_japanese": "ワン・フォー・オール",
"quirk_description": "A transferable Quirk that stockpiles power and grants immense strength, speed, stamina, and durability.",
"hero_school": "U.A. High School",
"class": "Class 1-A"
},
...],
"villains" : [
{
"id" : "46",
"name" : "Tenko Shimura",
"name_japanese" : "志村 転弧",
"other_names" : ["Tomura Shigaraki"],
"quirk" : "Decay",
"quirk_japanese" : "崩壊",
"quirk_description" : "Enables him to disintegrate whatever he touches with his fingers and anything connected to it.",
"affiliation" : "League of Villains"
},
...],
"heroes" : [
{
"id" : "92",
"name" : "Enji Todoroki",
"name_japanese" : "轟 炎司",
"hero_name" : "Endeavor",
"hero_name_japanese" : "エンデヴァー",
"quirk" : "Hellflame",
"quirk_japanese" : "ヘルフレイム",
"quirk_description" : "Gives him powerful pyrokinetic abilities. He is immune to other flames, and can easily control the shape and temperature of the blaze as well.",
"affiliation" : "Top Hero"
},
...],
"other" : [
{
"id" : "147",
"name" : "Inko Midoriya",
"name_japanese" : "緑谷 引子",
"civilian_description" : "Izuku's mother. She has an unnamed quirk that allows her to draw small objects to her with telekinesis-like power.",
"type" : "Civilian"
},
...]
}For data on a single character you can search by id:
curl https://myheroacademia-api.onrender.com/characters/{characterID}
Currently there is data for 57 students, 46 villains, 42 heroes and 15 civilians.
- /characters
- /students
- /villains
- /heroes
- /other
- /{characterID}
- Deployment
- CI/CD Pipelines
- Auto-deployment
- Linting workflow
- Testing workflow
- Contribution guides
- Data for all characters
- Students
- Villains
- Pro Heroes
- Other
- Civilians
- Episode Information
- Main
- Movies
- Specials (OVAs)
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Ensure you give a description of your changes. Don't forget to give the project a star! Thanks again!
- 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
Distributed under the MIT License. See LICENSE.txt for more information.
