PokeAPI is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.
The pokeapi_scrapy is a CRUD API that provides the data we scrapped from PokeAPI.
Basically, we use FastAPI Framework for make the API and requests for scrapy the PokeAPI.
The FastAPI provides a documentation about the API created using it, it's located on /docs endpoint.
Example:
If you run using the commands bellow, it is going to be on http://localhost:8080/docs.
To run this application, you're going to need docker and docker-compose.
If you don't have one of these, follow the respective guide:
With the previously listed dependencies installed and configurated correctly, clone the repository and start the application
# cloning the repository
git clone [email protected]:JohnathanBarb/pokeapi_scrapy.git
# going to cloned directory
cd pokeapi_scrapy
# copy the sample.env to a .env file and change the environment variables
cp sample.env .env
# running the application with docker-compose in detach mode
docker-compose up --build -d
# if necessary, to make a scrapy of the pokemons of PokeAPI
docker-compose exec web python scrapy_project/main.py
# to run the tests, use
docker-compose exec web pytest