/SmartREST

SpringBoot REST API template

Primary LanguageKotlinMIT LicenseMIT

Smart REST (Kotlin Edition)

MIT license Codacy Badge Actions CI

A template REST API project with

  • SpringBoot (Kotlin)
  • JPA (H2 DB in memory)
  • API REST with OpenAPI 3.0 documentation
  • Apache FreeMarker Template

Are you looking for a pure Java implementation? Try https://github.com/guildenstern70/smartrestjava

Build as Docker image

gradle clean assemble
docker build --platform linux/amd64 --build-arg JAR_FILE=build/libs/SmartRest.jar -t smartrest:1.0 .

Tag image to be uploaded to a repository

docker tag smartrest:1.0 docker.io/[your_user]/smartrest:1.0

Run docker image

docker run --publish 8080:8080 --name SmartRest smartrest:1.0

Install to Kubernetes using Helm

The provided Helm deploys on Kubernetes using one pod exposed by a service through NodePort

helm install --generate-name ./helm

To browse application get your k8s provider public IP, example with IBM Cloud

ibmcloud ks worker ls --cluster <cluster_name>

and point browser to

http(s)://<public_ip>:<node_port>