Overwatch API

The Overwatch API is a project aiming to make available as much data about Overwatch as possible. It does not concern itself with player data, as made available by other APIs, but instead focuses on base data about the game such as heroes, maps and abilities.

The API is hosted at overwatch-api.net:

> curl https://overwatch-api.net/api/v1/map/9
{  
    "id":9,
    "name":"Route 66",
    "location":"Route 66, United States of America",
    "url":"https://overwatch-api.net/api/v1/map/9",
    "mode":{  
        "id":3,
        "name":"Escort"
    },
    "stages":[  
        {  
            "id":7,
            "name":"Village"
        },
        {  
            "id":8,
            "name":"Shrine"
        },
        {  
            "id":9,
            "name":"Sanctum"
        }
    ],
    "event":null
}

Documentation

Full API documentation can be found at overwatch-api.net/docs/v1. For installation instructions, see below.

Installation

Overwatch API is built with Laravel so, if you're familiar with the framework, the installation and setup should be straight forward. If you've never used Laravel, not to worry - the Laravel documentation is thorough and so it's easy to get started.

It is recommended you run the API in Laravel Homestead, as this will take care of the necessary system dependencies and server configuration.

First clone the repository:

git clone git@github.com:jamesmcfadden/overwatch-api.git

Setup your configuration file:

cd overwatch-api
cp .env.example .env
php artisan key:generate

Install (if required) and run composer to install necessary dependencies:

composer install

If you're not using Laravel Homestead, ensure you point your web server to overwatch-api/public. The document index file is index.php. You'll also need to ensure your web server has read write permissions on the storage folder.

Database Setup

Setup the database using the Laravel Artisan tool from the project root:

php artisan migrate

This will create the database structure, and uses Laravel migrations.

Database Refresh

You'll often need to reset the database before re-importing, otherwise you'll get unique constraint errors from MySQL. To do so, run:

php artisan migrate:refresh

This will revert all migrations and re-run them, effectively wiping your database clean.

Importing Data

The data is stored in CSV format and can be found in resources/data. To import the data, run the following command from the project root:

php artisan import

If you receive an integrity constraint violation error, check you have refreshed your database (see above).

Deploy Script

There's a simple deploy script in the root directory aptly named deploy.sh. This will:

Pull the latest changes from the origin master branch;
Install the non-development dependencies using composer;
Force refresh the database;
Import the dataset

This script must be run from the root directory of the project.

Contribution

If you would like to contribute to the project, please follow the steps above to install the project on your system so you can make changes.

Data Contribution

If you would like to make additions or amendments to the project data, please read the following.

Data Format

The data is stored in CSV format to make it easier to import to a database when necessary. When you add or update the data, please ensure you follow the format:

id,name,description,hero_id,reward_id
1,Level 10,Reach level 10.,,30
2,Level 25,Reach level 25.,,40
3,Level 50,Reach level 50.,,39
4,"Achievement with a comma, in the title","Description with ""quotes"" within.",,335

That is:

Data files are headed with the associated database column names;
Records are separated with a newline character;
Record fields are separated with by a comma (,);
Text fields with a comma inside should be enclosed in quotes (");
Text fields with quotes inside should be escaped with another quote (");
Empty fields are treated as null

It is recommended to use spreadsheet software such as OSX's Numbers to write and export CSV files in the expected format.

Submitting Changes

Please open a pull request on GitHub.

License

View the license file here.

brianmontanaweb/overwatch-api