Context:
- Description
- Prerequisites
- Getting Started
- Maven Dependencies
- Redis Configuration
- Docker & Docker Compose
- Build & Run Application
- Endpoints with Swagger
- Demo
● This API facilitates to mange CRUD operations of cows.
● API has been implementd by using Java SpringBoot REST service.
● Potgres is used as the persistence layer while Redis is used as a cache layer.
To run Spring Boot based Account REST API it is prerequisite to have Java 8 & Docker installed on your machine.
● Steps to Install Java 8
● Steps to Install Docker
● Mavenis used to build dependancy of the project.
● It's not required to install PostgreSQL or Redis as services are run on Dcoker containers.
● But important to have undersandig of how PostgreSQL & Redis works (https://www.postgresql.org & https://redis.io )
* The application configure PostgreSQL and Redis with Java Spring Boot.Redis is most popular tool to use for caching.
* It is widely usage in the web application development.
* the application uses Dockerfile and docker-compose.yml files to dockerize containers
* Also Redis has been added with cache tag to docker-compose.yml file.
* Docker compose is a very useful tool to run more than one containers.Below dependencies are required to build and run the project.All dependencies are placed in the pom.xml.
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
</dependency>
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>@Configuration
@AutoConfigureAfter(RedisAutoConfiguration.class)
@EnableCaching
public class RedisConfig {
@Autowired
private CacheManager cacheManager;
@Value("${spring.redis.host}")
private String redisHost;
@Value("${spring.redis.port}")
private int redisPort;
@Bean
public RedisTemplate<String, Serializable> redisCacheTemplate(LettuceConnectionFactory redisConnectionFactory) {
RedisTemplate<String, Serializable> template = new RedisTemplate<>();
template.setKeySerializer(new StringRedisSerializer());
template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
template.setConnectionFactory(redisConnectionFactory);
return template;
}
@Bean
public CacheManager cacheManager(RedisConnectionFactory factory) {
RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig();
RedisCacheConfiguration redisCacheConfiguration = config
.serializeKeysWith(
RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
.serializeValuesWith(RedisSerializationContext.SerializationPair
.fromSerializer(new GenericJackson2JsonRedisSerializer()));
RedisCacheManager redisCacheManager = RedisCacheManager.builder(factory).cacheDefaults(redisCacheConfiguration)
.build();
return redisCacheManager;
}
}Dockerfile:
FROM openjdk:11
ADD ./target/herd-management-service-0.0.1-SNAPSHOT.jar /usr/src/herd-management-service-0.0.1-SNAPSHOT.jar
WORKDIR usr/src
ENTRYPOINT ["java","-jar", "herd-management-service-0.0.1-SNAPSHOT.jar"]Docker compose file: docker-compose.yml
version: '3'
services:
db:
image: "postgres"
ports:
- "5432:5432"
environment:
POSTGRES_DB: postgres
POSTGRES_USER: postgres
POSTGRES_PASSWORD: ekoloji
cache:
image: "redis"
ports:
- "6379:6379"
environment:
- ALLOW_EMPTY_PASSWORD=yes
- REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL
app:
build: .
ports:
- "8080:8080"
environment:
SPRING_DATASOURCE_URL: jdbc:postgresql://db/postgres
SPRING_DATASOURCE_USERNAME: postgres
SPRING_DATASOURCE_PASSWORD: ekoloji
SPRING_REDIS_HOST: cache
SPRING_REDIS_PORT: 6379
depends_on:
- db
- cache Please follow the below steps to build and run the application.Docker Compose Build and Run.
● Go to the project directory and open the terminal from outside of the project directory.
● Run the command 'mvn clean install -DskipTests'
● Run the command 'docker-compose build --no-cache'- Docker Compose Build.
● Run the command 'docker-compose up --force-recreate'- Docker Compose Run.
After running the application you can visit the enpoints at`http://localhost:8080/swagger-ui.html.API endpoint
Create a new cow
Get all cows
Update a cow
