This is the official FAForever API. Amongst others, the API offers the following functionality:
- OAuth 2.0 compliant authentication server
- User management (registration, password reset, etc.)
- JSON-API compliant REST API for lots of community data (i.e. map, mod & replay vault, game statistics, etc.)
- Leaderboards
- Clan management
- Vault upload functionality
- Internal FAF featured mod deployments
- Challonge proxy
The application requires a database scheme in the right version. To create this database please checkout the project faf-stack, open a shell terminal (git bash on Windows) and run the script scripts/init-db.sh. This will setup the database in the latest version and configure the users for you.
In order to run the application from source code:
- Clone the repository
- Import the project into IntelliJ. For some reason, IntelliJ deletes launch configurations after import. Please revert such deleted files first (Version Control (Alt+F9) -> Local Changes)
- Configure your JDK 8 if you haven't already
- Make sure you have the IntelliJ Lombok plugin installed
- Set up a FAF database.
- Launch
FafApiApplication
Given the number of required configuration values, it's easiest to run the API using faf-stack:
docker-compose up -d faf-java-api
- API documentation
- List event definitions
- List 5 maps with more than 8 players
- List UI mods, sorted by last updated ascending
- List all players
- List events of players
- List replays
This project uses:
- Java 8 as the programming language
- Spring Boot as a framework
- Hibernate ORM as ORM mapper
- Elide with RSQL filters to serve JSON-API conform data
- Gradle as a build automation tool
- Docker to deploy and run the application
- Swagger as an API documentation tool