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

docs: updated Response Schema from js to json

Browse Source
This commit is contained in:
Ritesh Ghosh
2023-08-06 20:34:05 +05:30
parent 8d7aa4db7f
commit e4a599750f
1 changed files with 197 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+193 -193
View File
@@ -117,83 +117,83 @@ console.log(data);
#### Response Schema #### Response Schema
```javascript ```json
{ {
genres: ["Action", "Cars", "Adventure", ...], "genres": ["Action", "Cars", "Adventure", ...],
latestEpisodeAnimes: [ "latestEpisodeAnimes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
duration: string, "duration": "string",
type: string, "type": "string",
rating: string, "rating": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
} }
}, },
{...}, {...},
], ],
spotlightAnimes: [ "spotlightAnimes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
jname: string, "jname": "string",
poster: string, "poster": "string",
description: string, "description": "string",
rank: number, "rank": "number",
}, },
{...}, {...},
], ],
top10Animes: { "top10Animes": {
today: [ "today": [
{ {
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
}, },
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
rank: number "rank": "number"
}, },
{...}, {...},
], ],
month: [...], "month": [...],
week: [...] "week": [...]
}, },
topAiringAnimes: [ "topAiringAnimes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
jname: string, "jname": "string",
poster: string, "poster": "string",
}, },
{...}, {...},
], ],
topUpcomingAnimes: [ "topUpcomingAnimes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
duration: string, "duration": "string",
type: string, "type": "string",
rating: string, "rating": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
} }
}, },
{...}, {...},
], ],
trendingAnimes: [ "trendingAnimes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
rank: number, "rank": "number",
}, "},"
{...}, {...},
], ],
} }
@@ -208,8 +208,8 @@ console.log(data);
#### 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. | Yes | -- |
#### Request sample #### Request sample
@@ -223,85 +223,85 @@ console.log(data);
#### Response Schema #### Response Schema
```javascript ```json
{ {
anime: [ "anime": [
info: { "info": {
id: string, "id": "string",
name: string, "name": "string"","
poster: string, "poster": "string",
description: string, "description": "string",
stats: { "stats": {
rating: string, "rating": "string",
quality: string, "quality": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number "dub": "number"
}, },
type: string, "type": "string",
duration: string "duration": "string"
} }
} }
moreInfo: { "moreInfo": {
aired: string, "aired": "string",
genres: ["Action", "Mystery", ...], "genres": ["Action", "Mystery", ...],
status: string, "status": "string",
studios: string, "studios": "string",
duration: string "duration": "string"
... ...
} }
], ],
mostPopularAnimes: [ "mostPopularAnimes": [
{ {
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
}, },
id: string, "id": "string",
jname: string, "jname": "string",
name: string, "name": "string",
poster: string, "poster": "string",
type: string "type": "string"
}, },
{...}, {...},
], ],
recommendedAnimes: [ "recommendedAnimes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
duration: string, "duration": "string",
type: string, "type": "string",
rating: string, "rating": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
} }
}, },
{...}, {...},
], ],
relatedAnimes: [ "relatedAnimes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
duration: string, "duration": "string",
type: string, "type": "string",
rating: string, "rating": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
} }
}, },
{...}, {...},
], ],
seasons: [ "seasons": [
{ {
id: string, "id": "string",
name: string, "name": "string",
title: string, "title": "string",
poster: string, "poster": "string",
isCurrent: boolean "isCurrent": "boolean"
}, },
{...} {...}
] ]
@@ -317,9 +317,9 @@ console.log(data);
#### Query Parameters #### Query Parameters
| Parameter | Type | Description | Required? | Default | | Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :---------------------------------------------------------------: | :-------: | :-----: | | :-------: | :------: | :---------------------------------------------------------------: | :-------: | :-----: |
| q | string | The search query, i.e. the title of the item you are looking for. | Yes | -- | | `q` | "string" | The search query, i.e. the title of the item you are looking for. | Yes | -- |
| page | number | The page number of the result. | No | `1` | | `page` | number | The page number of the result. | No | `1` |
#### Request sample #### Request sample
@@ -331,40 +331,40 @@ console.log(data);
#### Response Schema #### Response Schema
```javascript ```json
{ {
animes: [ "animes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
duration: string, "duration": "string",
type: string, "type": "string",
rating: string, "rating": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
} }
}, },
{...}, {...},
], ],
mostPopularAnimes: [ "mostPopularAnimes": [
{ {
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
}, },
id: string, "id": "string",
jname: string, "jname": "string",
name: string, "name": "string",
poster: string, "poster": "string",
type: string "type": "string"
}, },
{...}, {...},
], ],
totalPages: 1, "totalPages": 1,
currentPage: 1, "currentPage": 1,
hasNextPage: false "hasNextPage": false
} }
``` ```
@@ -377,14 +377,14 @@ console.log(data);
#### 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. | Yes | -- |
#### Query Parameters #### Query Parameters
| Parameter | Type | Description | Required? | Default | | Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :----------------------------: | :-------: | :-----: | | :-------: | :----: | :----------------------------: | :-------: | :-----: |
| page | number | The page number of the result. | No | `1` | | `page` | number | The page number of the result. | No | `1` |
#### Request sample #### Request sample
@@ -396,42 +396,42 @@ console.log(data);
#### Response Schema #### Response Schema
```javascript ```json
{ {
animes: [ "animes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
duration: string, "duration": "string",
type: string, "type": "string",
rating: string, "rating": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
} }
}, },
{...}, {...},
], ],
genreName: string, "genreName": "string",
genres: ["Action", "Cars", "Adventure", ...] "genres": ["Action", "Cars", "Adventure", ...]
topAiringAnimes: [ "topAiringAnimes": [
{ {
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
}, },
id: string, "id": "string",
jname: string, "jname": "string",
name: string, "name": "string",
poster: string, "poster": "string",
type: string "type": "string"
}, },
{...}, {...},
], ],
totalPages: 38, "totalPages": 38,
currentPage: 2, "currentPage": 2,
hasNextPage: true "hasNextPage": true
} }
``` ```
@@ -444,14 +444,14 @@ console.log(data);
#### Path Parameters #### Path Parameters
| Parameter | Type | Description | Required? | Default | | Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :--------------------: | :-------: | :-----: | | :--------: | :------: | :--------------------: | :-------: | :-----: |
| category | string | The category of anime. | Yes | -- | | `category` | "string" | The category of anime. | Yes | -- |
#### Query Parameters #### Query Parameters
| Parameter | Type | Description | Required? | Default | | Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :----------------------------: | :-------: | :-----: | | :-------: | :----: | :----------------------------: | :-------: | :-----: |
| page | number | The page number of the result. | No | `1` | | `page` | number | The page number of the result. | No | `1` |
#### Request sample #### Request sample
@@ -463,45 +463,45 @@ console.log(data);
#### Response Schema #### Response Schema
```javascript ```json
{ {
animes: [ "animes": [
{ {
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
duration: string, "duration": "string",
type: string, "type": "string",
rating: string, "rating": "string",
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
} }
}, },
{...}, {...},
], ],
category: string, "category": "string",
genres: ["Action", "Cars", "Adventure", ...] "genres": ["Action", "Cars", "Adventure", ...]
top10Animes: { "top10Animes": {
today: [ "today": [
{ {
episodes: { "episodes": {
sub: number, "sub": "number",
dub: number, "dub": "number",
}, },
id: string, "id": "string",
name: string, "name": "string",
poster: string, "poster": "string",
rank: number "rank": "number"
}, },
{...}, {...},
], ],
month: [...], "month": [...],
week: [...] "week": [...]
}, },
totalPages: 100, "totalPages": 100,
currentPage: 2, "currentPage": 2,
hasNextPage: true "hasNextPage": true
} }
``` ```