Desarrollo básico de una api utilizando Express-js como servidor base, el presente repositorio cuenta con un listado de tags` que permite identificar puntos claves durante el desarrollo.
Para poder iniciar el proyecto se necesita contar con las siguientes instalaciones.
-
NodeJS : es un entorno en tiempo de ejecución multiplataforma, de código abierto, para la capa del servidor basado en el lenguaje de programación ECMAScript.
-
Yarn : Es un tipo de instalador de paquetes JavaScript y gestor de dependencias lanzado por Facebook.
-
MongoDB : Este es un servicii en la nube que nos permite utilizar MongoDB puedes crear una cuenta si quieres probar su poder, en todo caso la practica cuenta ya con una conexión.
🔖 Nota : Se recomiendo descargar las versiones LTS (Long-Term Support).
Iniciaremos clonando el presente repositorio para este lo podemos hacer de dos maneras.
- Cunado no se esta utilizando una llave
SSH
git clone https://github.com/OrcaPracticas/api-pokemon.git- Cunado se esta utilizando una llave
SSH
git clone git@github.com:OrcaPracticas/api-pokemon.git🔖 Nota : En caso de que no sepas como configurar una llave SSH pues ver el siguiente articulo Connecting to GitHub with SSH
Al terminar de clonar el repositorio nos posicionaremos en el directorio que se genero.
cd ./api-pokemonAl estar en el directorio indicado, procederemos a realizar la instalación de dependencias esta acción la podemos realizar de 2 maneras.
- Usando yarn
yarn install- Usando npm
npm ial terminar la instalación de las dependencias procederemos a correr la aplicación.
🔖 Nota : Realmente yarn puede ser opcional, pero seria bueno que lo revisaras en el caso de que no lo conozcas.
Para poder correr la aplicación se pueden utilizar 2 opciones las cuales son.
Este es utilizado cuando estamos en el proceso de desarrollo del aplicativo por lo cual para esta opción s muy encontrar cosas como nodemon el cual nos permite refrescar el código conforme generemos cambios, el comando que se utilizaremos es.
- Usando yarn
yarn dev- Usando npm
npm run devEste es utilizado cuando el desarrollo esta listo para salir a la luz prácticamente se realizara la publicación.
- Usando yarn
yarn start- Usando npm
npm start🔖 Nota : Podrás ver el api en la ruta http://localhost:3000 o http://localhost:3000/api esta listara los primeros 150 pokémons.
Al tener el servidor arriba podremos realizar pruebas de todo lo que nos ofrece el Api,
-
⚙️random : Facilita la data de un pokémon de manera aleatoria, por ejemplo. http://localhost:3000/random o http://localhost:3000/api/random, al correr este comando podrás ver algo como esto (existe un nodo llamado
imgel cual te muestra una imagen referente al pokémon).
-
⚙️type : Realiza el filtro de los pokémon por tipo. http://localhost:3000/type/ghost o http://localhost:3000/api/type/ghost, al correr este comando podrás ver algo como esto.
- ⚙️name : Permite buscar pokémons por nombre completo o por incidencias. http://localhost:3000/name/char o http://localhost:3000/api/name/char, al correr este comando podrás ver algo como esto.
🔖 Nota : Cada método a consultar tiene que seguir la estructura
/[método]/[parámetro]o/api/[método]/[parámetro].
Es importante mencionar que el proyecto cuenta con tag's que facilita el movimiento entre las etapas del desarrollo realizado.
- ⚙️Configuración y Seteo inicial
- ✅Integracion de api terminada
- 🧪Integración de test
- 🛰Conexión con MongoDB
Cada una de las faces correspondientes al desarrollo, con su Release el cual tiene relación con un Pull-Request el cual su vez tiene relación con un Milestone el cual tienen relación con Issues y estos tienen relacionados los commits.
Para el desarrollo del presente proyecto se utilzan las siguientes dependnecias
Este proyecto está bajo la Licencia MIT mira el archivo LICENSE para detalles.
⌨️ con ❤️ por Konami12 😊.