Skip to content

A simple Spring Boot based RESTful API providing CRUD functionality over a database object

Notifications You must be signed in to change notification settings

nickmelis/payment-api

Repository files navigation

Spring Boot API sample application

This is a Java application based on the Spring Boot framework. It exposes a RESTful API that allows basic CRUD operations over objects of type payment. It has support for MySql database, although it can support any database for which a JDBC driver is available.

Build

Build

The application uses Gradle as dependency manager. Gradle version 5 or above is recommended, as the application has not been tested with previous versions. In order to build an executable jar it's enough to do

gradle build

in the console, in the root project folder. It will generate the main executable jar, together with the source and javadoc ones, under build/libs.

Run

Once the application JAR has been built, it can be run by doing

java -jar payment-api-0.0.1-SNAPSHOT.jar

in the console, in the folder where the jar is.

Database configuration

The application tries to connect by default to a MySql database on localhost:3306 and looks for the schema form3 The JDBC connection string is defined in application.properties, together with username and password, hence if you need different credentials you can change them in the file. However this configuration can be overridden at runtime too, by passing the following command line arguments:

--spring.datasource.url = jdbc:mysql://<HOST>:<PORT>/<SCHEMA_NAME>
--spring.datasource.username = <USERNAME>
--spring.datasource.password = <PASSWORD>

For example, passing the parameters as command line arguments:

java -jar payment-api-0.0.1-SNAPSHOT.jar --spring.datasource.url=jdbc:mysql://localhost:3306/form3?useSSL=false --spring.datasource.username=root --spring.datasource.password=passw0rd

or passing the parameters as JVM arguments:

java -Dspring.datasource.url=jdbc:mysql://localhost:3306/form3?useSSL=false -Dspring.datasource.username=root -Dspring.datasource.password=passw0rd -jar payment-api-0.0.1-SNAPSHOT.jar 

About

A simple Spring Boot based RESTful API providing CRUD functionality over a database object

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages