mirror of
https://github.com/jikan-me/jikan-rest.git
synced 2025-02-20 11:23:35 +08:00
update
This commit is contained in:
parent
21fe5ed886
commit
5ce7b7587b
55
README.MD
55
README.MD
@ -1,18 +1,45 @@
|
||||
# Jikan REST API Source
|
||||

|
||||
# Jikan - Unofficial MyAnimeList.net REST API
|
||||
[](http://isitmaintained.com/project/jikan-me/jikan-rest "Average time to resolve an issue") [](http://isitmaintained.com/project/jikan-me/jikan-rest "Percentage of issues still open") []() [](https://discord.gg/4q8E4Gg)
|
||||
|
||||
This REST API is built on Lumen and is in development, therefore neither will I produce or help in any form for any kind of in-depth installation/set up or guides for the time being
|
||||
Jikan is a REST API for [MyAnimeList.net](https://myanimelist.net). It scrapes the website to satisfy the need for an API - which MyAnimeList lacks.
|
||||
|
||||
The raison d'être of Jikan is to assist developers easily get the data they need for their apps and projects without having to depend on the lackluster official API, unstable APIs, or sidetracking their projects to develop parsers.
|
||||
|
||||
The word _Jikan_ literally translates to _Time_ in Japanese (**時間**). And that's what this API saves you of. ;)
|
||||
|
||||
|
||||
## What this requires
|
||||
- Composer
|
||||
- Lumen
|
||||
- BugSnag (API Key)
|
||||
- JikanPHP Library (just composer update)
|
||||
- Redis
|
||||
**Notice**: Jikan does not support authenticated requests. You can not update your lists.
|
||||
|
||||
## Quick set up
|
||||
1. Git Clone the repo
|
||||
2. Rename `.env.example` to `.env`
|
||||
3. `composer update`
|
||||
4. Make a BugSnag Account & set the API Key in `.env`
|
||||
5. Install Redis
|
||||
## Getting Started
|
||||
|
||||
### Requirements
|
||||
- [Composer](getcomposer.org/download/)
|
||||
- [Redis](https://redis.io)
|
||||
- PHP 7.1+
|
||||
|
||||
### Installation
|
||||
|
||||
1. `git clone https://github.com/jikan-me/jikan-rest.git`
|
||||
2. Rename `.env.dist` to `.env`
|
||||
3. `composer install`
|
||||
4. **Optional** Create a virtual host and point it to `/public`
|
||||
|
||||
## Information
|
||||
If you don't want to host your instance, there's a public API available.
|
||||
|
||||
- **[REST DOCUMENTATION](https://jikan.docs.apiary.io)**
|
||||
- **[Apps/Projects using JikanREST](https://jikan.moe/showcase)**
|
||||
|
||||
### Available Wrappers
|
||||
- **[.NET]** [Jikan.net](https://github.com/Ervie/jikan.net) by Ervie
|
||||
- **[Python]** [JikanPy](https://github.com/AWConant/jikanpy) by Andrew Conant & Abhinav Kasamsetty
|
||||
- **[Ruby]** [Jikan.rb](https://github.com/Zerocchi/jikan.rb) by Zerocchi
|
||||
- **[JavaScript]** [JikanJS](https://github.com/zuritor/jikanjs) by Zuritor
|
||||
- **[Java]** [Jikan4java](https://github.com/Doomsdayrs/Jikan4java) by Doomsdayrs
|
||||
|
||||
[Add your own wrapper here](https://github.com/jikan-me/jikan/edit/master/readme.md)
|
||||
|
||||
## DISCLAIMER
|
||||
- Jikan is not affiliated with MyAnimeList.net
|
||||
- You are responsible for the usage of this API. Please be respectful towards MyAnimeList's [Terms Of Service](https://myanimelist.net/about/terms_of_use)
|
||||
|
Loading…
x
Reference in New Issue
Block a user