ololx/restful-querying-instances

This is a java projects with simple instances of the restful service query method

restful-querying-instances

This project presents a several examples of the getting data method realizations of a spring rest service grouped by modules. Each module presents a small simple query method instance of the rest service layer.

---

📇 Table of Contents

• About
• Features
• Getting Started
• Built With
• Authors
• Licensing

📖 About

This is a collection of small and focused instances - each covering a single and well defined approach in the area of the java application development grouped by modeules. Each module is supposed to provide a separate simple instance. In this project each module presents a small simple instance of the querying approaches and technologies for the spring-boot restful service. A strong focus of these is, of course, the different test approaches of the spring-boot RESTful API.

Modules

This project includes the follows modules:

• query-dsl - this module is a simple spring-boot RESTful API which provides the read operations for the selecting item entities via dynamic querying with QueryDSL; This instance is listening on port 8081;
• specification-builder - this module is a simple spring-boot RESTful API which provides the read operations for the selecting item entities via dynamic querying with Custom Specification Builder; This instance is listening on port 8082;

🎚 Features

• The simple RESTful API which provides the read operations for the selecting item entities via dynamic querying.

To Do

• For more information on an upcoming development, please read the todo list.

Changelog

• For more information on a releases, a features and a changes, please read the changelog notes.

🚦 Getting Started

These instructions allow to get a copy of this project and run it on a local machine.

Prerequisites

Before using it, make sure that follows software are installed on the local machine:

• Oracle JDK 8+ - java development kit;
• Maven 3+ - dependency management;

If any of the listed software is not installed, then it can be installed by instruction as described below.

1. Oracle JDK 8+

   • Install Oracle JDK 8+ according to instructions from an official instruction.

2. Maven 3+

   • Install Maven 3+ according to instructions from an official source.

Installing

In order to install it is quite simple to clone or download this repository.

Cloning

For the cloning this repository to a local machine, just use the follows link:

https://github.com/ololx/restful-querying-instances

Using

To use it is necessary to: 1 - Build the project. 2 - Launch the instances. 3 - Send http request

Building the project

To do the full build, execute maven goal install in the root directory by the following command:

mvn clean install

Building a single module

To do the full build, execute maven goal install in the module directory by the following command:

mvn clean install

Launching in command line

To do the run examples, execute maven goal spring-boot:run in the module directory by the following command:

mvn spring-boot:run

Launching in IDE

This is a multi-module project. Each model is supposed to provide a separate example. That's why when you're working with an individual module, there's no need to import all of them (or build all of them) - you can simply import that particular module in either Eclipse, NetBeanse or IntelliJ IDEA and run each example in IDE.

Sending http request

Just use the follows link by method GET:

https://localhost:{port-of-module}/items?{request}

🛠 Built With

• Oracle JDK - java development kit;
• Maven - dependency management;
• H2 database - database management system;

©️ Authors

• Alexander A. Kropotin - project work - ololx.

🔏 Licensing

This project is licensed under the MIT license - see the lisence document for details.