famapi

A RESTful API for managing family trees.

Prerequisites

• Docker Desktop
• Java Development Kit (JDK) 21
• (optional) Maven 3.6+

Run

Recommended: To use the Maven Wrapper and the provided JDK, run the following command to start the server:

• Windows

  ./mvnw.cmd spring-boot:run

• Linux

  ./mvnw spring-boot:run

You can also run the following command to forces the use of the Maven Central Repository

    ./mvnw.cmd -s .\.mvn\wrapper\settings.xml spring-boot:run

Note: to The flag -s .\.mvn\wrapper\settings.xml forces the use of the Maven Central Repository for downloading dependencies, overriding any settings in the .m2/settings.xml file.

The server will start on localhost:8080.

API Documentation

Swagger UI

swagger is available http://localhost:8080/swagger-ui/index.html