From 2a7af2f647aafa241fa3158ac88d42ca5a442390 Mon Sep 17 00:00:00 2001 From: carlos-burelo Date: Tue, 9 Nov 2021 11:13:07 -0600 Subject: [PATCH] Add documentation to base endpoint --- src/routes/api.routes.js | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/src/routes/api.routes.js b/src/routes/api.routes.js index 81b015f..e7d0a50 100644 --- a/src/routes/api.routes.js +++ b/src/routes/api.routes.js @@ -17,6 +17,27 @@ import { routes.get('/', (_, res) => { res.json({ message: 'API Works', + endpoints: { + lastest: '/lastest', + emision: '/emision', + getAnimeByID: '/anime/:id', + getAnimesByPage: '/animes/:page', + getEpisodeByID: '/ver/:id', + searchAnimeByID: '/search/:id', + getYears: '/years', + getGenders: '/genders', + getLetters: '/letter', + getCategories: '/categories', + getByParams: { + example: '/?gender=drama&sort=title&order=asc', + filters: ['gender', 'year', 'category', 'letter'], + querys: { + sort: '&sort={prop}', + order: '&order=asc', + limit: '&limit=3...(soon)', + }, + }, + }, }); }); @@ -41,18 +62,15 @@ routes.get('/search/:id', (req, res) => { routes.get('/genders', (req, res) => { getGenders(req, res); }); - routes.get('/categories', (req, res) => { getCategories(req, res); }); routes.get('/years', (req, res) => { getYears(req, res); }); - routes.get('/letters', (req, res) => { getLetters(req, res); }); - routes.get('/by', (req, res) => { getBy(req, res); });