Skip to content

Kaede-No-Ki/otakudesu-rest-api

Repository files navigation

OtakuDesu API

GitHub issues GitHub pull requests GitHub GitHub stars GitHub forks GitHub watchers GitHub contributors GitHub last commit

Unofficial API of : https://otakudesu.org/

TODO

  • Home
    • Ongoing
    • complete
  • Ongoing Pagination
  • Complete Pagination
  • Schedule
  • Genre List
    • Anime By Genre
  • Detail Anime
    • Detail
    • Batch
    • Episode List
  • Detail Batch
    • Download Link
  • Detail Episode
    • Download Link
    • Streaming Link
  • Search

Usage

  1. Clone this repository
git clone https://github.com/Kaede-No-Ki/otakudesu-rest-api.git
  1. Install packages (use yarn or npm)
npm install
  1. Start server
npm run start

or

npm run dev (you have to install nodemon on your computer)

API Documentation

Api Path : https://otakudesu-api.herokuapp.com/api/
API Version : v1

Endpoint Params Description
/home - Homepage
/complete - Complete/Finished Anime
/complete/page/${page} pageNumber Complete Pagination
/ongoing - Ongoing Anime
/schedule - Schedule Anime
/genres - Genre List
/genres/${id}/page/${page} id,pageNumber Show Anime by Genre
/search/${query} query Search Anime
/anime/${id} id Detail Anime
/batch/${id} id Detail Anime's Batch
/eps/${id} id Detail Anime's Episode

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT