Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 2.47 KB

README.md

File metadata and controls

50 lines (39 loc) · 2.47 KB
Raw

Anime News Network Data Client

Tests Maintainability Test Coverage

This is a PHP client wrapper for the Anime News Network data API. If you are interested in contributing back to this project, feel free to read the Contributing documentation below.

NOTE: When using this client to retrieve data, you must still abide by the ANN API terms of service:

When using this API to display information on a public website, you must list Anime News Network as the source of the data and link to Anime News Network on every page that incorporates data from the API.

Requires

  • PHP ^8.0
  • Composer (to install this library)

Usage

<?php
$client = new sprak3000\AnimeNewsNetworkDataAPI\Client();
$anime = $client->getAnime(['anime' => '16148'])->toArray();
$manga = $client->getManga(['manga' => '4199'])->toArray();

Detecting API Errors

Unfortunately, the ANN API does not return a non 200 HTTP response code for an invalid / not found ID. To check for an error, look for a warning key in the result array.

Known Limitations / Issues

None at this time.

Installing via Composer

composer require sprak3000/AnimeNewsNetworkDataAPI

Continuous Integration

This project uses GitHubActions for build and continuous integration.

Documentation

All documentation can be found in the doc folder.

Contributing