Toy REST

A minimal functional example for a http REST service created with Spring Boot.

NOTE: Since this is a Github repository template, create a new application based on this repo and start your project directly.

How to run

First compile the project and build an executable java archive:

mvn clean package

The JAR file will be created in the /target folder:

|-target
|---spring-boot-rest-template-1.0.0-SNAPSHOT.jar
|---...

Just change into the folder and run the REST service app with:

java -jar spring-boot-rest-template-1.0.0-SNAPSHOT.jar

Configuration

Properties

The default configuration of the app binds to the local port 8080 to the systems localhost:

http://localhost:8080

If you want to change the server port, let's say 8085, you can configure it by setting the server.port property explicitly:

java -jar -Dserver.port=8085 spring-boot-rest-template-1.0.0-SNAPSHOT.jar

Environment Variables

You can configure the application further by specifying the following environment variables:

Environment Variable	Description	Default Value

How to use

The application provides only one endpoint that you can query with a simple GET HTTP request. Just call the endpoint with the project ID QTEST and see what happens:

curl -v http://localhost:8081/projects/QTEST

This will give you the following terminal output:

*   Trying ::1...
* TCP_NODELAY set
* Connected to localhost (::1) port 8081 (#0)
> GET /projects/QTEST HTTP/1.1
> Host: localhost:8081
> User-Agent: curl/7.64.1
> Accept: */*
>
< HTTP/1.1 200
< Content-Type: application/json
< Transfer-Encoding: chunked
< Date: Wed, 02 Feb 2022 14:03:42 GMT
<
* Connection #0 to host localhost left intact
{"code":"QTEST","title":"Test project","description":"Just a test project"}* Closing connection 0

Checkout the 200 HTTP response code for OK and the content of the response body, which is a JSON representation of a simple project resource match.

Endpoints

Currently, there is only one HTTP GET endpoint to query different project resources:

/projects/{id}

Working project identifiers are QTEST and QABCD.

Add this library as a dependency

This library is not hosted on maven central. To use it, you have to include our artifact repository to your pom.

<repositories>
    <repository>
        <releases>
            <enabled>true</enabled>
            <updatePolicy>always</updatePolicy>
            <checksumPolicy>fail</checksumPolicy>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
        <id>nexus-releases</id>
        <name>QBiC Releases</name>
        <url>https://qbic-repo.qbic.uni-tuebingen.de/repository/maven-releases</url>
    </repository>
</repositories>

Then include this library as an artifact.

<dependency>
    <groupId>...</groupId>
    <artifactId>...</artifactId>
    <version>...</version>
</dependency>

sven1103/toy-repo