Hijitus-API

Objetivo de la API

La idea es que cualquiera pueda contrubuir a este proyecto con lo que considere que podria mejorar la API. Dada la gran popularidad entre los desarrolladores front-end de las APIs de "Rick and Morty", "PokeAPI", "Dragon Ball API", etc., pensé que sería divertido tener una versión argentina. Por eso, elegí al primer superhéroe animado argentino para desarrollarla.

Lenguaje

Esta API está construida en Typescript utilizando el entorno de Node.js con su sistema de módulos y el framework Express.js, siguiendo la arquitectura MVC.

• El testing de este backend se realiza utilizando el framework Jest y la libreria supertest

Base de datos

Actualmente, no existe la necesidad de crear una base de datos, y un archivo JSON es suficiente para administrarla. En próximas versiones, es muy probable que se porte a MongoDB.

Librerías

• cors: Para el manejo de los CORS.
• nodemon: dependencia de desarrollo para manejar el reinicio de la api al modificar codigo.

Instalacion

1. Clona este repositorio:

git clone https://github.com/Bartoloni00/hijitus-api.git

2. Navega al directorio del proyecto:

cd hijitus-api

3. Instala las dependencias:

npm install

4. compila el proyecto:

npm run build

5. Inicia el proyecto:

npm run start

Uso de la API

Ruta raiz de la api

llamando a la ruta raiz de la api encontraremos este mismo readme el cual incluye toda la documentacion

http://localhost:3333

Obtener todos los personajes de la serie de Hijitus.

Realiza una peticion por GET a la siguiente URL:

http://localhost:3333/characters

Paginacion

Los personajes vienen dividos por paginas actualmente, por defecto vienen 10 personajes en 3 paginas diferentes, de la siguiente manera podras modificar la pagina:

http://localhost:3333/characters?page=2

Y esta es la forma en la que podras modificar la cantidad de personajes que habra por pagina (default = 10)

http://localhost:3333/characters?items=2

Filtros

Tip

Los filtros pueden ser concatenados en un mismo query string.

Filtrar por categoria:

http://localhost:3333/characters?category=secundario

http://localhost:3333/characters?category=protagonista

http://localhost:3333/characters?category=antagonista

http://localhost:3333/characters?category=episodico

Filtrar por especie:

http://localhost:3333/characters?species=robot

http://localhost:3333/characters?species=humano

http://localhost:3333/characters?species=perro

http://localhost:3333/characters?species=humano

http://localhost:3333/characters?species=mounstruo

http://localhost:3333/characters?species=canguro

http://localhost:3333/characters?species=pajaro

http://localhost:3333/characters?species=dragon

http://localhost:3333/characters?species=Pingüino

http://localhost:3333/characters?species=Búho

Filtrar por personalidad:

http://localhost:3333/characters?personality=neutral

http://localhost:3333/characters?personality=bueno

http://localhost:3333/characters?personality=malo

Filtrar por genero:

http://localhost:3333/characters?gender=femenino

http://localhost:3333/characters?gender=masculino

http://localhost:3333/characters?gender=N/A

Filtrar por descripcion:

Buscar por cualquier frase o palabra que pueda estar incluida en la descripcion.

http://localhost:3333/characters?description=amigo%20de%20hijitus

obtener un personaje en concreto de la serie.

Realiza una peticion por GET a la siguiente URL:

http://localhost:3333/characters/{numeroId}

Note

Los id de los personajes actualmente van del 1 al 28.

Filtros

obtener un personaje aleatorio de la serie.

Realiza una peticion por GET a la siguiente URL:

http://localhost:3333/characters/random

Contribuciones

Si deseas contribuir a este proyecto, por favor, abre un issue o realiza un pull request. ¡Toda ayuda es bienvenida!

Licencia

Este proyecto está bajo la Licencia MIT.