https://github.com/colinbut/pokedex
Pokemon Index - An example web application developed using Dropwizard
https://github.com/colinbut/pokedex
dropwizard java jdbi
Last synced: about 2 months ago
JSON representation
Pokemon Index - An example web application developed using Dropwizard
- Host: GitHub
- URL: https://github.com/colinbut/pokedex
- Owner: colinbut
- Created: 2016-09-10T15:30:41.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-08T10:06:12.000Z (about 8 years ago)
- Last Synced: 2025-03-27T10:16:25.190Z (7 months ago)
- Topics: dropwizard, java, jdbi
- Language: Java
- Homepage:
- Size: 214 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pokedex
**DISCLAIMER: All data in this project are fictional**
## Pokemon Index
This is an application developed using Dropwizard. It represents the famous 'Pokedex' which is an index of Pokemons (Pocket Monsters).
This pokedex is the original pokedex consisting of 150 pokemon. Mew the 151st is therefore not included.
What this web application does is that you hit the specified endpoint and it will return the pokemon data containing its name, combat power, hit points, list of attacks in JSON format. You give the id of the pokemon you want to retreive and it will return the pokemon data by the given id.
### Build
```
mvn clean package
```
### Running
Navigate to the application project directory. Depending on the type of setup,
1. for single module - go to default/ and run application from this folder
2. for multi-module - go to multi-module/project-application/ and run application from this folder
```
java -jar target/pokedex-1.0-SNAPSHOT.jar server src/main/resources/pokedex.yaml
```
note that:
`server` is the command to indicate starting this application as a HTTP Server. (Jetty HTTP Server is started up)
`src/main/resources/pokedex.yaml` is the application configuration file in yaml (yml) format and this reside under the appropriate project folder
### Hitting the endpoint
http://localhost:8080/pokemon/25
Note that 25 is the pokemon index of Pikachu :heart_eyes:
```JSON
{
"id":25,
"name":"Pikachu",
"hitPoints":61,
"combatPower":777,
"type":{
"typeName":"ELECTRIC"
},
"attacks":[
{
"name":"Thunder Shock",
"power":40,
"accuracy":100,
"typeRepresentation":{
"typeName":"ELECTRIC"
}
},
{
"name":"Thunderbolt",
"power":90,
"accuracy":100,
"typeRepresentation":{
"typeName":"ELECTRIC"
}
}
]
}
```
### Key Technologies
- Dropwizard
- Jersey (JAX-RS)
- Jackson JSON
- Jetty
- JDBI
- SLF4J/Logback
- Liquibase
- Freemarker
- Mustache
- Hibernate
### Dropwizard Modules
- dropwizard-core
- dropwizard-jdbi
- dropwizard-migrations
- dropwizard-assets
- dropwizard-views-freemarker
- dropwizard-views-mustache
- dropwizard-hibernate
### Database
Uses MySQL database. You will need to have MySQL in your local. Download it from the MySQL website and follow its installation instructions to install it.
The database configuration details are specified in the pokedex.yaml application configuration file:
```
database:
# the name of your JDBC driver
driverClass: com.mysql.jdbc.Driver
# the username
user: root
# the password
password:
# the JDBC URL
url: jdbc:mysql://localhost:3306/pokemon
```
### Liquibase
Database management is done using Liquibase patches. The patches live under the following directory location:
`src/main/resources/liquibase/`
where migrations.xml contains list of individual patches to run.
Run the following command to update the database:
```
java -jar target/pokedex-1.0-SNAPSHOT.jar db migrate src/main/resources/pokedex.yaml
```
and to rollback:
```
java -jar target/pokedex-1.0-SNAPSHOT.jar db rollback src/main/resources/pokedex.yaml --count=4
```
where `--count` tag indicates number of patches to rollback
### View
Freemarker/Mustache template engine is used to render views of the resources in a nicely representation for display.
### Database Access
Provides 2 types of database access. You can either choose JDBI or Hibernate.
you can configure this via the following property in the pokedex.yaml application configuration file:
```
# can be Hibernate or JDBI
dataAccess: Hibernate
```
By default, JDBI is configured if not property not set.