aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOmer Y. Bayraktar <[email protected]>2024-07-11 16:13:22 +0300
committerOmer Y. Bayraktar <[email protected]>2024-07-11 16:13:22 +0300
commita663833e680a8a7be0cfdca34216156edf9a23ae (patch)
tree55e557ae20b5e88efe976dd4f59b567041cc4fd4
parent0b38b7a2e32f6060a1b1babd6583cf3227478568 (diff)
downloadaniwatch-api-a663833e680a8a7be0cfdca34216156edf9a23ae.tar.xz
aniwatch-api-a663833e680a8a7be0cfdca34216156edf9a23ae.zip
api document minimize
-rw-r--r--README.md66
1 files changed, 66 insertions, 0 deletions
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.
+<details>
+
+<summary>Get Anime Home Page</summary>
+
### `GET` Anime Home Page
#### Endpoint
@@ -258,6 +262,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Anime About Info</summary>
+
### `GET` Anime About Info
#### Endpoint
@@ -396,6 +406,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Anime Search Results</summary>
+
### `GET` Search Results
#### Endpoint
@@ -493,6 +509,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Anime Search Suggestions</summary>
+
### `GET` Search Suggestions
#### Endpoint
@@ -536,6 +558,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Producer Animes</summary>
+
### `GET` Producer Animes
#### Endpoint
@@ -625,6 +653,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Genre Animes</summary>
+
### `GET` Genre Animes
#### Endpoint
@@ -698,6 +732,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Category Anime</summary>
+
### `GET` Category Anime
#### Endpoint
@@ -774,6 +814,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Estimated Schedules</summary>
+
### `GET` Estimated Schedules
#### Endpoint
@@ -816,6 +862,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Anime Episodes</summary>
+
### `GET` Anime Episodes
#### Endpoint
@@ -859,6 +911,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Anime Episode Servers</summary>
+
### `GET` Anime Episode Servers
#### Endpoint
@@ -915,6 +973,12 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
+<details>
+
+<summary>Get Anime Episode Streaming Links</summary>
+
### `GET` Anime Episode Streaming Links
#### Endpoint
@@ -972,6 +1036,8 @@ console.log(data);
[🔼 Back to Top](#table-of-contents)
+</details>
+
## <span id="development">👨‍💻 Development</span>
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.