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

docs(endpoints): added new endpoints & updated existing ones

Browse Source
This commit is contained in:
Ritesh Ghosh
2023-08-13 19:25:33 +05:30
parent 689aa384d4
commit a4de55af01
1 changed files with 171 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+171 -33
View File
@@ -67,6 +67,8 @@
- [GET Anime Home Page](#get-anime-home-page) - [GET Anime Home Page](#get-anime-home-page)
- [GET Anime About Info](#get-anime-about-info) - [GET Anime About Info](#get-anime-about-info)
- [GET Search Results](#get-search-results) - [GET Search Results](#get-search-results)
- [GET Search Suggestions](#get-search-suggestions)
- [GET Producer Animes](#get-producer-animes)
- [GET Genre Animes](#get-genre-animes) - [GET Genre Animes](#get-genre-animes)
- [GET Category Anime](#get-category-anime) - [GET Category Anime](#get-category-anime)
- [Development](#development) - [Development](#development)
@@ -79,26 +81,24 @@
1. Clone the repository and move into the directory. 1. Clone the repository and move into the directory.
```bash ```bash
git clone https://github.com/ghoshRitesh12/aniwatch-api.git git clone https://github.com/ghoshRitesh12/aniwatch-api.git
cd aniwatch-api cd aniwatch-api
``` ```
2. Install all the dependencies. 2. Install all the dependencies.
```bash ```bash
npm ci #or yarn install npm ci #or yarn install
``` ```
3. Rename the `.env.example` file to `.env` and update any details required. 3. Start the server!
4. Start the server! ```bash
npm start #or yarn start
```
```bash Now the server should be running on [http://localhost:4000](http://localhost:4000)
npm start #or yarn start
```
Now the server should be running on [http://localhost:4000](http://localhost:4000)
## <span id="documentation">📚 Documentation</span> ## <span id="documentation">📚 Documentation</span>
@@ -108,7 +108,9 @@ Below are the endpoints exposed by the api:
#### Endpoint #### Endpoint
`http://localhost:4000/anime/home` ```bash
http://localhost:4000/anime/home
```
#### Request sample #### Request sample
@@ -206,13 +208,15 @@ console.log(data);
#### Endpoint #### Endpoint
`http://localhost:4000/anime/info?id={anime-id}` ```sh
http://localhost:4000/anime/info?id={anime-id}
```
#### Query Parameters #### Query Parameters
| Parameter | Type | Description | Required? | Default | | Parameter | Type | Description | Required? | Default |
| :-------: | :------: | :------------------: | :-------: | :-----: | | :-------: | :----: | :----------------------------------: | :-------: | :-----: |
| `id` | "string" | The unique anime id. | Yes | -- | | `id` | string | The unique anime id (in kebab case). | Yes | -- |
#### Request sample #### Request sample
@@ -315,7 +319,9 @@ console.log(data);
#### Endpoint #### Endpoint
`http://localhost:4000/anime/search?q={query}&page={page}` ```sh
http://localhost:4000/anime/search?q={query}&page={page}
```
#### Query Parameters #### Query Parameters
@@ -365,23 +371,153 @@ console.log(data);
}, },
{...}, {...},
], ],
totalPages: 1,
currentPage: 1, currentPage: 1,
totalPages: 1,
hasNextPage: false hasNextPage: false
} }
``` ```
### `GET` Search Suggestions
#### Endpoint
```sh
http://localhost:4000/anime/search/suggest?q={query}
```
#### Query Parameters
| Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :--------------------------: | :-------: | :-----: |
| `q` | string | The search suggestion query. | Yes | -- |
#### Request sample
```javascript
const resp = await fetch(
"http://localhost:4000/anime/search/suggest?q=monster"
);
const data = await resp.json();
console.log(data);
```
#### Response Schema
```javascript
{
suggestions: [
{
id: string,
name: string,
poster: string,
jname: string,
moreInfo: ["Jan 21, 2022", "Movie", "17m"]
},
{...},
],
}
```
### `GET` Producer Animes
#### Endpoint
```sh
http://localhost:4000/anime/producer/{name}?page={page}
```
#### Path Parameters
| Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :-----------------------------------------: | :-------: | :-----: |
| `name` | string | The name of anime producer (in kebab case). | Yes | -- |
#### Query Parameters
| Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :----------------------------: | :-------: | :-----: |
| `page` | number | The page number of the result. | No | `1` |
#### Request sample
```javascript
const resp = await fetch(
"http://localhost:4000/anime/producer/toei-animation?page=2"
);
const data = await resp.json();
console.log(data);
```
#### Response Schema
```javascript
{
producerName: "Toei Animation Anime",
animes: [
{
id: string,
name: string,
poster: string,
duration: string,
type: string,
rating: string,
episodes: {
sub: number,
dub: number,
}
},
{...},
],
top10Animes: {
today: [
{
episodes: {
sub: number,
dub: number,
},
id: string,
name: string,
poster: string,
rank: number
},
{...},
],
month: [...],
week: [...]
},
topAiringAnimes: [
{
episodes: {
sub: number,
dub: number,
},
id: string,
jname: string,
name: string,
poster: string,
type: string
},
{...},
],
currentPage: 2,
totalPages: 11,
hasNextPage: true,
}
```
### `GET` Genre Animes ### `GET` Genre Animes
#### Endpoint #### Endpoint
`http://localhost:4000/anime/genre/{name}?page={page}` ```sh
http://localhost:4000/anime/genre/{name}?page={page}
```
#### Path Parameters #### Path Parameters
| Parameter | Type | Description | Required? | Default | | Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :----------------------: | :-------: | :-----: | | :-------: | :----: | :--------------------------------------: | :-------: | :-----: |
| `name` | string | The name of anime genre. | Yes | -- | | `name` | string | The name of anime genre (in kebab case). | Yes | -- |
#### Query Parameters #### Query Parameters
@@ -401,6 +537,7 @@ console.log(data);
```javascript ```javascript
{ {
genreName: "Shounen Anime",
animes: [ animes: [
{ {
id: string, id: string,
@@ -416,8 +553,7 @@ console.log(data);
}, },
{...}, {...},
], ],
genreName: string, genres: ["Action", "Cars", "Adventure", ...],
genres: ["Action", "Cars", "Adventure", ...]
topAiringAnimes: [ topAiringAnimes: [
{ {
episodes: { episodes: {
@@ -432,8 +568,8 @@ console.log(data);
}, },
{...}, {...},
], ],
totalPages: 38,
currentPage: 2, currentPage: 2,
totalPages: 38,
hasNextPage: true hasNextPage: true
} }
``` ```
@@ -442,7 +578,9 @@ console.log(data);
#### Endpoint #### Endpoint
`http://localhost:4000/anime/{category}?page={page}` ```sh
http://localhost:4000/anime/{category}?page={page}
```
#### Path Parameters #### Path Parameters
@@ -468,6 +606,7 @@ console.log(data);
```javascript ```javascript
{ {
category: "TV Series Anime",
animes: [ animes: [
{ {
id: string, id: string,
@@ -483,8 +622,7 @@ console.log(data);
}, },
{...}, {...},
], ],
category: string, genres: ["Action", "Cars", "Adventure", ...],
genres: ["Action", "Cars", "Adventure", ...]
top10Animes: { top10Animes: {
today: [ today: [
{ {
@@ -502,8 +640,8 @@ console.log(data);
month: [...], month: [...],
week: [...] week: [...]
}, },
totalPages: 100,
currentPage: 2, currentPage: 2,
totalPages: 100,
hasNextPage: true hasNextPage: true
} }
``` ```
@@ -518,4 +656,4 @@ Don't forget to leave a star 🌟
## <span id="license">📜 License</span> ## <span id="license">📜 License</span>
[MIT License](https://github.com/ghoshRitesh12/aniwatch-api/blob/main/LICENSE) This project is licensed under the [MIT License](https://opensource.org/license/mit/) - see the [LICENSE](https://github.com/ghoshRitesh12/aniwatch-api/blob/main/LICENSE) file for more details.