Employee API

The Employee API is a Spring Boot application that allows you to manage employee data. It provides endpoints for creating, updating, retrieving, and deleting employees, as well as exposing API documentation using Swagger. This project integrated with Kafka for producing any update on Employee.

Requirements

• Docker
• Docker Compose
• Apache maven

Project Structure

The project follows the Domain-Driven Design (DDD) principles and is structured as mentioned in below:

• main
  • java
    • com.meysamzamani.employee
      • application
      • domain
      • infrastructure
        • kafka
        • persistence
      • presentation
        • controller
        • dto
        • exceptions
        • validation
    • resources
• test
  • java
    • com.meysamzamani.employee
      • application
      • domain
      • infrastructure
        • kafka
        • persistence
      • presentation
        • controller

How to Build and Run

1. Clone the repository to your local machine:

    git clone https://github.com/meysamzamani/EmployeeAPI.git
    cd EmployeeAPI
   

2. Build the project using Maven:

    mvn clean package -Pprod
   

   The build artifacts will be generated in the target directory.

3. Start the Docker Compose environment:

    docker-compose up -d
   

   If you're using MacOSX you can run this command

    docker compose up -d
   

   The Docker Compose command will start all the services defined in the docker-compose.yml file, including Kafka, ZooKeeper, PostgreSQL, and the Spring Boot application.

4. Access the application:

   Once the Docker Compose environment is up and running, you can access the RESTful APIs of the Spring Boot application at This URL.

Database Configuration

The application uses Hibernate as the ORM (Object-Relational Mapping) tool to interact with the database. The hibernate.ddl-auto property is a configuration option that controls the database schema generation strategy during application startup.

hibernate.ddl-auto: create-drop

• The hibernate.ddl-auto property is set to create-drop in the application's configuration. With create-drop, Hibernate will automatically create the necessary database schema when the application starts up, and it will drop the schema when the application shuts down. If you want to keep data in database after every project run please change this value to update like example:

    hibernate:
        ddl-auto: update
  

APIs Documentation (Swagger)

The application exposes its RESTful APIs using Swagger. Once the application is running, you can access the Swagger UI to explore and interact with the APIs at the following URL:

Swagger Url

Kafka Integration

The application uses Kafka to publish events related to employee creation, update, and deletion. Kafka configuration and integration are handled in the KafkaConfiguration class and the Kafka-related components in the infrastructure.kafka package.

Kafka topics are created automatically when events are published for the first time.

Unit Tests and Integration Test

The project includes unit tests for the core business logic, service layer, and domain entities. The unit tests are implemented using JUnit 5 and Mockito to isolate components and mock external dependencies. Integration tests are provided to ensure that the application's components work correctly together and interact with external dependencies, such as the database and Kafka. Integration tests are implemented using JUnit 5 and Testcontainers to set up a temporary Kafka container for testing. To run the tests, use the following command:

mvn test

Author

Meysam Zamani