Skip to content
 
 

Repository files navigation

PokéAPI

Java Spring PostgreSQL Badge Docker Badge Gradle Badge

This API has been developed to facilitate the creation and retrieval of Pokémon data, functioning similar to a Pokédex.

Using this API, you can perform CRUD operations on various aspects of Pokémon, including Pokémon themselves, Generations, Regions, Stats, Artworks, and Pokémon Types.

Please note that this API is still a work in progress and has been designed for practice purposes. Your feedback is greatly appreciated! :)

Requirements

For building and running the application you need:

Running the application locally

There are several ways to run a Spring Boot application on your local machine. One way is to execute the main method in the com.gcruz.pokeapi.PokeApiApplication class from your IDE. Remember to configure the posgresql db on your machine.

Alternatively you can use docker-compose commands to start or stop this application and its database, i.e

docker-compose up

Application properties (w/docker)

  • Server port: 8081
  • DB configuration:
Host: localhost 
Port: 6543
Database: pokedb
Username: postgres 
Password: postgres

API Collection

In the link below you will find the Postman collection with pre-made examples.

PokeAPI Postman Collection

Credits

Pokémon artwork and sprites urls used on this Api has been obtained from Pokémon Database page.

About

Rest api created with Java, Spring Boot, PostgreSQL and Docker

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages