shishantbiswas/aniwatch-api
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api document minimize

Browse Source
This commit is contained in:
Omer Y. Bayraktar
2024-07-11 16:13:22 +03:00
parent 0b38b7a2e3
commit a663833e68
1 changed files with 66 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+66
View File
@@ -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.