Zelda API

Description

This repository holds the code of the Zelda API, a RESTful API and GraphQL API of "The Legend of Zelda" game franchise, which provides you with games, characters, enemies, bosses, dungeons and more! The Zelda API is currently deployed on vercel, and can be accessed with the following url: https://zelda.fanapis.com/

NextJS never cease to amaze me! So I started this project as some kind of proof of concept application, proving that it is possible to build an API with MongoDB using such a powerful tool. This is an experimental implementation, so some availability problems can be expected.

New Version!

I'm proud to announce a few exciting changes. Here's a list of what this new version offers:

• GraphQL endpoints
• CORS will no longer be an issue
• GraphQL Testing Sandbox
• Improved performance
• Documentation rewrite
• Zelda API data made public.
• Anyone can deploy it and get it working just like this repository does.
• Changed main domain to zelda.fanapis.com (zelda-api.apius.cc will still be supported)
• Code improvements
• Upgrade to NodeJS 14x
• Upgrade to NextJS 12

Getting Started

Since this API doesn't require you to provide an API key, it's extremely easy to use. Feel free to explore our documentation and test routes!

Example REQUEST

Let's retrieve a list of all released games with the following route:

• METHOD: GET

• URL: http://zelda.fanapis.com/api/games?limit=2

• RESULT

{
    "success": true,
    "count": 2,
    "data": [
        {
            "id": "5f6ce9d805615a85623ec2b7",
            "name": "The Legend of Zelda",
            "description": "The Legend of Zelda is the first...",
            "developer": "Nintendo R&D 4",
            "publisher": "Nintendo",
            "released_date": " February 21, 1986",
        },
        {
            "id": "5f6ce9d805615a85623ec2b8",
            "name": "The Legend of Zelda: A Link to the Past",
            "description": "One day, a band of evil thieves managed to...",
            "developer": "Nintendo",
            "publisher": "Nintendo",
            "released_date": " April 13, 1992",
        }
    ]
}

Example REQUEST (GRAPHQL)

Let's retrieve a monster called "Lizalfos", I want this API to return its name, description and which games this monster is featured. So let's make a POST request with the following GraphQL body:

query {
	monsters(name: "Lizalfos") {
		name,
		description,
		appearances {
			name,
			released_date,
		}
	}
}

Then the GraphQL API will return:

• RESULT

{
	"data": {
		"monsters": [
			{
				"name": "Lizalfos",
				"description": "Lizalfos are recurring Enemies in The Legend of Zelda series. ",
				"appearances": [
					{
						"name": "The Legend of Zelda: Ocarina of Time",
						"released_date": " November 23, 1998"
					},
					{
						"name": "The Legend of Zelda: Twilight Princess",
						"released_date": " November 19, 2006"
					},
					{
						"name": "The Legend of Zelda: Skyward Sword",
						"released_date": " November 20, 2011"
					},
					{
						"name": "The Legend of Zelda: Breath of the Wild",
						"released_date": " March 3, 2017"
					}
				]
			}
		]
	}
}

Pretty easy, huh? Go to https://zelda.fanapis.com/api/graphql and use the data for your project as you like

Documentation

An awesome documentation can be found on https://docs.zelda.fanapis.com

Tech Stack

Database: MongoDB

Deployment: Vercel

Engine: NextJS

Building

In order to build this project just clone this repository and install the dependencies:

user@admin:~$ git clone https://github.com/deliton/zelda-api.git && cd zelda-api
user@admin:~/idt$ npm install && npm run dev

Deploy

You can also quickly deploy a version of this repository using Vercel. Just create an account there, import this repository and that's it, it's done. In order to properly use this API it is necessary to define some ENVIRONMENT VARIABLES:

MONGODB_URI= URI TO CONNECT TO A MONGODB DATABASE

API_URL= URL TO THE DOMAIN OF YOUR API

Project

This project is currently being built with NextJS and MongoDB, but still is a work in progress. Stay tuned to the upcoming versions here on Github.