helderlinhares / webflux-r2dbc-postgres-crud-api

This is a simple example of a Reactive CRUD API using Kotlin, Spring Webflux and R2DBC PostgreSQL Database.

Webflux API

Description

This is a simple example of a Reactive Project using Kotlin and Spring Webflux to create, edit, delete and find an item.

This project also uses a PostgreSQL R2DBC Driver to support Reactive connection on the Database.

Technical Info

• Technologies:
  • Kotlin
  • Spring Boot
  • Spring Webflux
  • PostgreSQL R2DBC
  • Flyway Migration
  • Docker Compose
  • Gradle
• Database:
  • PostgreSQL

Building from Source

To clean/build the project from the console use the command:

    gradle clean build

To run only tests from the console use the command:

    gradle test

OBS: You can also use your IDE to run Gradle tasks.

Running the project

The first thing you need to do is prepare your database.

You can do that by using docker compose on docker folder as detailed on Using Docker Compose session of this document.

With your database already prepared you just use the command below to Run the project:

    gradle bootRun

OBS: You can also use your IDE to run the Project.

Using Flyway

Flyway will create and populate the database when the application starts.

If for some reason you need to perform a manual migration, use the command:

    gradle flywayMigrate

OBS: You can also use your IDE to run Gradle tasks.

Using Docker Compose

In Tab "Terminal" access the folder docker and type docker-compose up -d {{service_name}}.

After that, the service will be available in a docker container.

Useful Commands:

• Start Container: docker-compose up -d {{service_name}}
• Stop Container: docker-compose down -d {{service_name}}
• Logs: docker-compose logs {{service_name}}
• Logs in Real Time: docker-compose logs -f {{service_name}}

Service names available for this project:

• postgres (Database)

Postman

To use this api you can install Postman and import the collection available on webflux-api/postman folder.

To import the collection on Postman:

1. Select the Menu File > Import
2. Click on Upload Files button (File tab)
3. Select webflux-api/postman/webflux-api.postman_collection.json file to import.