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

[bytelovers]

Creation an API documentation of kings league, contains all endpoints from other contributions
It's the first version and It's only visible opening the file 'index.html'

Pending:

• Create doc:api command to generate API doc
• Publish in a server endpoint
• Modify host to set dynamically on generate site
• Response examples
• General api documentation (API versioning, etc...)

[Fasping]

FILE: api/teams.routes.js

This code includes error handling to catch any issues that may occur when reading the teams.json file, and it also uses an if statement to check whether the team was found before returning the JSON response. 😊

--------------------------------------

import { Hono } from 'hono'
import fs from 'fs'

const teamsApi = new Hono()
let teams

try {
teams = JSON.parse(fs.readFileSync('../db/teams.json', 'utf8'))
} catch (error) {
console.error(Error reading teams.json: ${error})
}

teamsApi.get('/', (ctx) => {
return ctx.json(teams)
})

teamsApi.get('/:id', (ctx) => {
const id = ctx.req.param('id')
const foundTeam = teams.find((team) => team.id === id)

if (!foundTeam) {
return ctx.json({ message: 'Team not found' }, 404)
}

return ctx.json(foundTeam)
})

export { teamsApi }

[Fasping]

FILE: api/presidents.routes.js

Implementacióne:

1. • Una importación para el módulo fs, que proporciona una API para interactuar con el sistema de archivos.
2. • Un try...catch para manejar cualquier error que pueda ocurrir al leer el archivo presidents.json. El bloque try contiene la función fs.readFileSync, que lee el contenido del archivo y lo devuelve como una cadena. El bloque catch registra un mensaje de error en la consola si ocurre un error.
3. • Comentarios de documentación en línea al código. Los comentarios de la documentación usan la especificación OpenAPI, que es un estándar para describir las API REST. Los comentarios incluyen información sobre las rutas de la API, como el método HTTP y la ruta, así como los parámetros de solicitud y respuesta para cada ruta.
4. • Modifiqué la ruta /:id para incluir una declaración if que verifique si se encontró un presidente antes de devolver la respuesta JSON. Si no se encuentra un presidente, la ruta devuelve un objeto JSON con un mensaje de error y un código de estado 404.

Tienes el codigo debajo por si quieres implementarlo en otro commit ❤️

---

`
import { Hono } from 'hono'
import fs from 'fs'

const presidentApi = new Hono()
let presidents

try {
presidents = JSON.parse(fs.readFileSync('../db/presidents.json', 'utf8'))
} catch (error) {
console.error(Error reading presidents.json: ${error})
}

/**

• @api {get} /presidents Get all presidents
• @apiName GetPresidents
• @APIGroup Presidents
• @apiSuccess {Object[]} presidents List of presidents.
• @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 }
`

[bytelovers]

FILE: api/presidents.routes.js

Implementacióne:

1. • Una importación para el módulo fs, que proporciona una API para interactuar con el sistema de archivos.
2. • Un try...catch para manejar cualquier error que pueda ocurrir al leer el archivo presidents.json. El bloque try contiene la función fs.readFileSync, que lee el contenido del archivo y lo devuelve como una cadena. El bloque catch registra un mensaje de error en la consola si ocurre un error.
3. • Comentarios de documentación en línea al código. Los comentarios de la documentación usan la especificación OpenAPI, que es un estándar para describir las API REST. Los comentarios incluyen información sobre las rutas de la API, como el método HTTP y la ruta, así como los parámetros de solicitud y respuesta para cada ruta.
4. • Modifiqué la ruta /:id para incluir una declaración if que verifique si se encontró un presidente antes de devolver la respuesta JSON. Si no se encuentra un presidente, la ruta devuelve un objeto JSON con un mensaje de error y un código de estado 404.

Tienes el codigo debajo por si quieres implementarlo en otro commit ❤️

` import { Hono } from 'hono' import fs from 'fs'

const presidentApi = new Hono() let presidents

try { presidents = JSON.parse(fs.readFileSync('../db/presidents.json', 'utf8')) } catch (error) { console.error(Error reading presidents.json: ${error}) }

/**

• @api {get} /presidents Get all presidents
• @apiName GetPresidents
• @APIGroup Presidents
• @apiSuccess {Object[]} presidents List of presidents.
• @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 } `

No puedo usar los paquetes de node porque sino el wrangler no me arranca, pero sí que he añadido la doc al resto de endpoints.

Gracias!

[Fasping]

Great job buddy!