From a663833e680a8a7be0cfdca34216156edf9a23ae Mon Sep 17 00:00:00 2001 From: "Omer Y. Bayraktar" Date: Thu, 11 Jul 2024 16:13:22 +0300 Subject: api document minimize --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/README.md b/README.md index fe64e58..d69f8ad 100644 --- a/README.md +++ b/README.md @@ -150,6 +150,10 @@ Deploy your own instance of Aniwatch API on Render. The endpoints exposed by the api are listed below with examples that uses the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), but you can use any http library. +
+ +Get Anime Home Page + ### `GET` Anime Home Page #### Endpoint @@ -258,6 +262,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Anime About Info + ### `GET` Anime About Info #### Endpoint @@ -396,6 +406,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Anime Search Results + ### `GET` Search Results #### Endpoint @@ -493,6 +509,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Anime Search Suggestions + ### `GET` Search Suggestions #### Endpoint @@ -536,6 +558,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Producer Animes + ### `GET` Producer Animes #### Endpoint @@ -625,6 +653,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Genre Animes + ### `GET` Genre Animes #### Endpoint @@ -698,6 +732,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Category Anime + ### `GET` Category Anime #### Endpoint @@ -774,6 +814,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Estimated Schedules + ### `GET` Estimated Schedules #### Endpoint @@ -816,6 +862,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Anime Episodes + ### `GET` Anime Episodes #### Endpoint @@ -859,6 +911,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Anime Episode Servers + ### `GET` Anime Episode Servers #### Endpoint @@ -915,6 +973,12 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ +
+ +Get Anime Episode Streaming Links + ### `GET` Anime Episode Streaming Links #### Endpoint @@ -972,6 +1036,8 @@ console.log(data); [🔼 Back to Top](#table-of-contents) +
+ ## 👨‍💻 Development Pull requests and stars are always welcome. If you encounter any bug or want to add a new feature to this api, consider creating a new [issue](https://github.com/ghoshRitesh12/aniwatch-api/issues). If you wish to contribute to this project, read the [CONTRIBUTING.md](https://github.com/ghoshRitesh12/aniwatch-api/blob/main/CONTRIBUTING.md) file. -- cgit v1.2.3