Table of contents

• General info
• Word In Progress
• Technologies
• Setup
• Using the API
• Licence

General Info

This project is a simple To-Do REST API built with Spring Boot and Spring Security.

A live version of the API is currently running for testing purposes. It can be found here.

WIP

This is a work in progress. The following features and improvements are in the process of being implemented:

• Cache local data
• Add HTTP Cache-Control headers to all HTTP responses
• Add ETags to responses to GET requests
• Log all incoming connections in separate .log file (done)
• Cache session tokens in a local Redis cache
• Replace H2 in-memory database with SQLite (done)
• Log all incoming connections in separate .log file
• Cache session tokens in a local Redis cache
• Replace H2 in-memory database with SQLite done
• Implement authentication with OAuth2

You can find more information in the issues section.

Technologies

This project uses:

• Java - Open JDK 16
• Spring Boot
• Spring Security
• SpringFoX
• Hibernate Validator
• MapStruct

Setup

To run the project yourself, navigate into the project folder and use the command:

$ mvn install 

If you do not have the Maven build tool installed, you will need to install it.

Once Maven has completed installing, run the program with:

$ java -jar to-do-api-0.0.1-SNAPSHOT.jar

Using the API

API documentation is available on SwaggerHub and as part of a publicly available Postman Collection. You will find everything you need to use TO-DO-API here.

Licence

Apache 2.0