feat: add documentation of API (/w refactor of routes)

api/index.js

@@ -1,11 +1,12 @@
 import { Hono } from 'hono'
 import { serveStatic } from 'hono/serve-static.module'
 import leaderboard from '../db/leaderboard.json'
-import teams from '../db/teams.json'
-import presidents from '../db/presidents.json'
-import coachs from '../db/coachs.json'
-import top_scorer from '../db/top_scorer.json'
-import mvp from '../db/mvp.json'
+
+import { coachesApi } from './routes/coaches.routes'
+import { mvpApi } from './routes/mvp.routes'
+import { presidentApi } from './routes/presidents.routes'
+import { teamsApi } from './routes/teams.routes'
+import { topScorerApi } from './routes/top-scorer.routes'
 
 const app = new Hono()
 
@@ -34,39 +35,11 @@ app.get('/leaderboard', (ctx) => {
   return ctx.json(leaderboard)
 })
 
-app.get('/presidents', (ctx) => {
-  return ctx.json(presidents)
-})
-
-app.get('/coachs\\/?', (ctx) => {
-  return ctx.json(coachs)
-})
-
-app.get('/top-scorer', (ctx) => {
-	return ctx.json(top_scorer)
-})
-
-app.get('/mvp', (ctx) => {
-	return ctx.json(mvp)
-})
-
-app.get('/presidents/:id', (ctx) => {
-  const id = ctx.req.param('id')
-  const foundPresident = presidents.find((president) => president.id === id)
-
-  return foundPresident
-    ? ctx.json(foundPresident)
-    : ctx.json({ message: 'President not found' }, 404)
-})
-
-app.get('/teams/:id', (ctx) => {
-  const id = ctx.req.param('id')
-  const foundTeam = teams.find((team) => team.id === id)
-
-  return foundTeam
-    ? ctx.json(foundTeam)
-    : ctx.json({ message: 'Team not found' }, 404)
-})
+app.route('/presidents', presidentApi)
+app.route('/teams', teamsApi)
+app.route('/top-scorer', topScorerApi)
+app.route('/mvp', mvpApi)
+app.route('/coachs', coachesApi)
 
 app.get('/static/*', serveStatic({ root: './' }))
 

api/routes/coaches.routes.js

@@ -0,0 +1,20 @@
+import { Hono } from 'hono'
+
+import coaches from '../../db/coaches.json'
+
+const coachesApi = new Hono()
+
+/**
+	@api {GET} /coaches Get all coaches
+	@apiName GetCoaches
+	@APIGroup Coaches
+	@apiSuccess {Object[]} Coaches list.
+	@apiSuccess {String} coaches.name Name of coach.
+	@apiSuccess {String} coaches.teamName Name of team belongs to coach.
+	@apiSuccess {String} coaches.image Image o the coach.
+*/
+coachesApi.get('/', (ctx) => {
+  return ctx.json(coaches)
+})
+
+export { coachesApi }

api/routes/mvp.routes.js

@@ -0,0 +1,23 @@
+import { Hono } from 'hono'
+
+import mvp from '../../db/mvp.json'
+
+const mvpApi = new Hono()
+
+/**
+	@api {GET} /mvp Get all presidents
+	@apiName GetMVPPlayers
+	@APIGroup MVP
+	@apiSuccess {Object[]} MVP List of players.
+	@apiSuccess {String} MVP.playerName MVP player's name.
+	@apiSuccess {String} MVP.gamesPlayed Player games.
+	@apiSuccess {String} MVP.mvps Number of MVPs
+	@apiSuccess {String} MVP.rank Ranking position
+	@apiSuccess {String} MVP.team Team belongs to player
+	@apiSuccess {String} MVP.image Logo of the team
+*/
+mvpApi.get('/', (ctx) => {
+  return ctx.json(mvp)
+})
+
+export { mvpApi }

api/routes/presidents.routes.js

@@ -0,0 +1,40 @@
+import { Hono } from 'hono'
+
+import presidents from '../../db/presidents.json'
+
+const presidentApi = new Hono()
+
+/**
+	@api {GET} /presidents Get all presidents
+	@apiName GetPresidents
+	@APIGroup Presidents
+	@apiSuccess {Object[]} presidents list.
+	@apiSuccess {Number} presidents.id President ID.
+	@apiSuccess {String} presidents.name President name.
+	@apiSuccess {String} presidents.party President political party.
+*/
+presidentApi.get('/', (ctx) => {
+	return ctx.json(presidents)
+})
+/**
+	@api {GET} /presidents/:id Get a president by ID
+	@apiName GetPresidentById
+	@APIGroup Presidents
+	@apiParam {Number} id President ID.
+	@apiSuccess {Object} president President object.
+	@apiSuccess {Number} president.id President ID.
+	@apiSuccess {String} president.name President name.
+	@apiSuccess {String} president.party President political party.
+	@apiError (404) {Object} NotFoundError President not found.
+*/
+presidentApi.get('/:id', (ctx) => {
+	const id = ctx.req.param('id')
+	const foundPresident = presidents.find((president) => president.id === id)
+	if (!foundPresident) {
+		return ctx.json({ message: 'President not found' }, 404)
+	}
+
+	return ctx.json(foundPresident)
+})
+
+export { presidentApi }

api/routes/teams.routes.js

@@ -0,0 +1,50 @@
+import { Hono } from 'hono'
+
+import teams from '../../db/teams.json'
+
+const teamsApi = new Hono()
+
+/**
+	@api {GET} /teams Get all teams
+	@apiName GetTeams
+	@APIGroup Teams
+	@apiSuccess {Object[]} team list.
+	@apiSuccess {Number} teams.id Team ID.
+	@apiSuccess {String} teams.name Team name.
+	@apiSuccess {String} teams.image Team image.
+	@apiSuccess {String} teams.url Team URL.
+	@apiSuccess {Number} presindent.id ID of President belongs to team.
+	@apiSuccess {String} teams.channel URL of channel of the team.
+	@apiSuccess {Array} teams.socialNetwork List of networks of the team.
+	@apiSuccess {Array} teams.players List of players belongs to team.
+	@apiSuccess {String} teams.coach Name of the coach.
+*/
+teamsApi.get('/', (ctx) => {
+  return ctx.json(teams)
+})
+
+/**
+	@api {GET} /teams/id Get team by ID
+	@apiName GetTeams
+	@APIGroup Teams
+	@apiSuccess {Number} teams.id Team ID.
+	@apiSuccess {String} teams.name Team name.
+	@apiSuccess {String} teams.image Team image.
+	@apiSuccess {String} teams.url Team URL.
+	@apiSuccess {Number} presindent.id ID of President belongs to team.
+	@apiSuccess {String} teams.channel URL of channel of the team.
+	@apiSuccess {Array} teams.socialNetwork List of networks of the team.
+	@apiSuccess {Array} teams.players List of players belongs to team.
+	@apiSuccess {String} teams.coach Name of the coach.
+	@apiError (404) {Object} NotFoundError Team not found.
+*/
+teamsApi.get('/:id', (ctx) => {
+  const id = ctx.req.param('id')
+  const foundTeam = teams.find((team) => team.id === id)
+
+  return foundTeam
+    ? ctx.json(foundTeam)
+    : ctx.json({ message: 'Team not found' }, 404)
+})
+
+export { teamsApi }

api/routes/top-scorer.routes.js

@@ -0,0 +1,23 @@
+import { Hono } from 'hono'
+
+import top_scorer from '../../db/top_scorer.json'
+
+const topScorerApi = new Hono()
+
+/**
+	@api {GET} /top-scorer Get Top Scorers
+	@apiName GetTopScorer
+	@APIGroup Top Scorers
+	@apiSuccess {Object[]} Top Scorers.
+	@apiSuccess {String} topScorer.playerName Top Scorer's name.
+	@apiSuccess {String} topScorer.gamesPlayed Played games.
+	@apiSuccess {String} topScorer.goals Number of goals
+	@apiSuccess {String} topScorer.rank Ranking position
+	@apiSuccess {String} topScorer.team Team belongs to player
+	@apiSuccess {String} topScorer.image Logo of the team
+*/
+topScorerApi.get('/', (ctx) => {
+  return ctx.json(top_scorer)
+})
+
+export { topScorerApi }