Skip to content
AnimeNLPublic

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

7 watching

Forks

Repository files navigation

AnimeCon REST API

Installation instructions

Pre requisites:

  • PHP 7.4+
  • An functional AnPlan database

To get started you will need to clone the API, and copy the .env file to a .env.local file.

In your .env.local file, please edit the DATABASE_URL parameter to point to your AnPlan database.

Next, run composer install and configure your webserver of choice to point to public/index.php. Ensure that the APP_ENV is set to prod in the event that you are setting up a production environment, otherwise you might expose your credentials.

Important! Do not under any circumstance run any Doctrine command.

Run bin/console lexik:jwt:generate-keypair to generate required keys. Run bin/console animecon:token:generate to see if you can generate a JWT token.

Working with the API

Getting started with the API is easy, simply navigate to the hostname you've configured in your webserver and you will be presented with a fully fledged documentation.

Some endpoints and properties may require authentication, documentation for this is pending (and so is the authentication itself.)

Building a client

Due to the fact that the API is built upon API Platform (https://api-platform.com/) it is relatively easy to adapt it's output to your needs. This is also the reason the default response may be overkill for your use case, for a regular JSON response you'll want to set the Accept header to application/json.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

7 watching

Forks

Releases

Packages

Used by

Contributors

Languages