{"id":19331378,"url":"https://github.com/andriykalashnykov/spring-boot-demo","last_synced_at":"2025-04-22T23:31:57.087Z","repository":{"id":44670303,"uuid":"280734982","full_name":"AndriyKalashnykov/spring-boot-demo","owner":"AndriyKalashnykov","description":"Spring Boot REST microservices","archived":false,"fork":false,"pushed_at":"2025-01-28T23:10:16.000Z","size":674,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-18T23:46:00.134Z","etag":null,"topics":["buildkit","buildpacks","docker-compose","docker-image","dockerfile","github-workflows","kaniko","mongodb","restful-api","skaffold","spring-boot","swagger","swagger-api","swagger-ui"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AndriyKalashnykov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-18T20:34:50.000Z","updated_at":"2025-01-28T23:10:13.000Z","dependencies_parsed_at":"2025-01-28T01:22:46.356Z","dependency_job_id":"62ff0c86-0930-484a-8c48-15bcbd98311b","html_url":"https://github.com/AndriyKalashnykov/spring-boot-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndriyKalashnykov%2Fspring-boot-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndriyKalashnykov%2Fspring-boot-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndriyKalashnykov%2Fspring-boot-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndriyKalashnykov%2Fspring-boot-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndriyKalashnykov","download_url":"https://codeload.github.com/AndriyKalashnykov/spring-boot-demo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250340322,"owners_count":21414526,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["buildkit","buildpacks","docker-compose","docker-image","dockerfile","github-workflows","kaniko","mongodb","restful-api","skaffold","spring-boot","swagger","swagger-api","swagger-ui"],"created_at":"2024-11-10T02:39:50.877Z","updated_at":"2025-04-22T23:31:56.806Z","avatar_url":"https://github.com/AndriyKalashnykov.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![test](https://github.com/AndriyKalashnykov/spring-boot-demo/workflows/test/badge.svg?branch=master)](https://github.com/AndriyKalashnykov/spring-boot-demo/actions?query=workflow%3Atest)\n[![ci](https://github.com/AndriyKalashnykov/spring-boot-demo/workflows/ci/badge.svg?branch=master)](https://github.com/AndriyKalashnykov/spring-boot-demo/actions?query=workflow%3Aci)\n[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FAndriyKalashnykov%2Fspring-boot-demo\u0026count_bg=%2333CD56\u0026title_bg=%23555555\u0026icon=\u0026icon_color=%23E7E7E7\u0026title=hits\u0026edge_flat=false)](https://hits.seeyoufarm.com)\n# Spring Boot REST microservice\n\nJava / Maven / Spring Boot microservice / Docker image / Buildkit / Buildpacks / Kaniko / Skaffold/ K8s Deployment / Minikube\n\n* Full integration with the latest **Spring** Framework 2.x.x: inversion of control, dependency injection, etc.\n* Packaging as a single jar with embedded container (tomcat 8)\n* Demonstrates how to set up healthcheck, metrics, info, environment, etc. endpoints automatically on a configured port. Inject your own health / metrics info with a few lines of code.\n* RESTful service using annotation: supports both XML and JSON request / response\n* Exception mapping from application exceptions to the right HTTP response with exception details in the body\n* *Spring Data* Integration with JPA/Hibernate / MongoDB\n* CRUD functionality with H2 in-memory data source using Spring *Repository* pattern\n* MockMVC test framework\n* Self-documented APIs: Swagger2 using annotations\n* Buildkit\n* Buildpacks\n* Kaniko\n* Skaffold\n* K8s Deployment / Minikube\n\n## Pre-requisites\n\n- [sdkman](https://sdkman.io/install)\n\n    Install OpenJDK 11.x\n    \n    ```shell\n    sdk install java 11.0.11.hs-adpt\n    sdk default java 11.0.11.hs-adpt\n    sdk use java 11.0.11.hs-adpt\n    ```\n- [Apache Maven](https://maven.apache.org/install.html)\n- [Docker](https://docs.docker.com/engine/install/)\n- [Virtualbox](https://www.virtualbox.org/manual/ch02.html)  \n- [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)\n- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)\n- [Buildpacks.io](https://buildpacks.io/docs/tools/pack/)  \n- [curl](https://help.ubidots.com/en/articles/2165289-learn-how-to-install-run-curl-on-windows-macosx-linux)\n- [httpie](https://httpie.org/doc#installation)  \n- [jq](https://github.com/stedolan/jq/wiki/Installation)\n- [xmllint](https://command-not-found.com/xmllint)\n\n## Build and Run\n\nThis application is packaged as a jar which has Tomcat 8 embedded.\n\n* Clone this repository\n  \n```shell\ngit clone git@github.com:AndriyKalashnykov/spring-boot-demo.git\ncd spring-boot-demo\n```\n\n* Build the project and run the service\n\n```shell\n  mvn clean package spring-boot:run -Drun.arguments=\"spring.profiles.active=default\" -DskipTests\n```\n  \nor\n\n```\n  mvn clean package\n  java -jar -Dspring.profiles.active=default target/spring-boot-demo-1.0.jar\n```\n\n### Application health, configurations, Git commit info, documentation links\n\n```shell\nhttp://localhost:8080/actuator/info\nhttp://localhost:8080/actuator/health\nhttp://localhost:8080/actuator/env\nhttp://localhost:8080/actuator/health/hotelServiceHealth\nhttp://localhost:8080/actuator/metrics\n\nhttp://localhost:8080/commitid?mediaType=json\n\nhttp://localhost:8080/v2/api-docs\nhttp://localhost:8080/swagger-ui/index.html\n```\n\n### Microservice API\n\n```shell\ncurl -X POST 'http://localhost:8080/example/v1/hotels' --header 'Content-Type: application/json' --header 'Accept: application/json' --data @hotel.json --stderr -\n```\n\nor\n\n```shell\nhttp POST 'http://localhost:8080/example/v1/hotels' \u003c hotel.json\n```\n\nor\n\n```shell\ncurl -X POST 'http://localhost:8080/example/v1/hotels' --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{\"name\":\"Beds R Us\",\"description\":\"Very basic, small rooms but clean\",\"city\":\"Santa Ana\",\"rating\":2}' --stderr -\n```\n\n### Retrieve paginated list of hotels\n\n```shell\ncurl -X GET --silent 'http://localhost:8080/example/v1/hotels?page=0\u0026size=10\u0026mediaType=json' --stderr -  2\u003e\u00261 | jq .\n```\n\nor\n\n```shell\nhttp  'http://localhost:8080/example/v1/hotels?page=0\u0026size=10\u0026mediaType=json'\n```\n\n### Swagger 2 API docs\n\n```shell\nopen -a /Applications/Google\\ Chrome.app http://localhost:8080/swagger-ui/index.html\n```\n\n### Building docker image\n\n#### Optional, local test only: Using local maven cache\n\nIn order to build image quickly by compiling maven project using host OS  maven repo\n\nBuild project, artifact will be placed in \"$PWD\"/target\n\n```shell\ncd spring-boot-demo\ndocker run -v ~/.m2:/root/.m2 -v \"$PWD\":/usr/src -w /usr/src maven:3-jdk-11 mvn clean package\n```\n\n#### Build multi-stage image with BuildKit\n\nDocker Build enhancements for 18.09 release introduces a \nmuch-needed overhaul of the build architecture. \nBy integrating BuildKit, users should see an improvement on \nperformance, storage management, feature functionality, \nand security.\n\n```shell\ncd spring-boot-demo\ndocker rm -f spring-boot-demo\nDOCKER_BUILDKIT=1 docker build  -f Dockerfile -t spring-boot-demo .\n```\n#### Login to Image Registry\n\n```shell\n# provide image registry login and password\nDOCKER_LOGIN=\nDOCKER_PWD=\ndocker login --username $DOCKER_LOGIN --password $DOCKER_PWD docker.io\n```\n\n#### Build image with Buildpacks\n\n```shell\n./scripts/build-dockerimage-buildpacks.sh\n```\n\n#### Build image with Kaniko\n\n```shell\n./scripts/build-dockerimage-kaniko.sh\n```\n\n#### Test application\n\n```shell\ncd ./scripts\n# adding 100 to port number to avoid local conflicts: 8081-\u003e8181\ndocker run --rm --name spring-boot-demo -p 8080:8080 -p 8181:8081 spring-boot-demo:latest\n\ncurl -X POST 'http://localhost:8080/example/v1/hotels' --header 'Content-Type: application/json' --header 'Accept: application/json' --data @hotel.json --stderr -\ncurl -X GET --silent 'http://localhost:8080/example/v1/hotels?page=0\u0026size=10' --stderr -  2\u003e\u00261 | jq .\n```\n\n### Attaching to the application from IDE\n\nRun the service with these command line options:\n\n```shell\nmvn clean package spring-boot:run -Drun.jvmArguments=\"-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005\"\n```\n\nor\n\n```shell\njava -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -Dspring.profiles.active=test -Ddebug -jar target/spring-boot-demo-1.0.jar\n```\n\nIntelliJ : Run -\u003e Edit configuration -\u003e Remote.\n\n![IntelliJ IDEA](./img/idea-remote.png)\n\n### Deploy application to K8s\n\n```shell\nminikube delete --all\nminikube start -p minikube --memory=16384 --cpus=6 --disk-size=30g --vm-driver=virtualbox\neval $(minikube docker-env)\neval \"$(docker-machine env -u)\"\n# minikube start --vm-driver=virtualbox --extra-config=apiserver.anonymous-auth=false --insecure-registry=localhost:5000\n\nmvn clean package -DskipTests -Pk8s fabric8:undeploy\nmvn clean package -Pk8s fabric8:deploy\n\nminikube ssh 'docker logs $(docker ps -a -f name=k8s_kube-api --format={{.ID}})'\n```\n\n### Deploy application to k8s overriding runtime JDK/JRE\n\n```shell\nmvn clean package fabric8:deploy -Dfabric8.generator.from=fabric8/java-alpine-openjdk11-jdk\n```\n\n### Test application deployed on K8s\n\n```shell\ncurl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --data @hotel.json $(minikube service spring-boot-rest-example --url | sed -n 1p)/example/v1/hotels\nhttp $(minikube service spring-boot-demo --url | sed -n 1p)/example/v1/hotels?page=0\u0026size=10\n\nhttp $(minikube service spring-boot-demo --url | sed -n 2p)/swagger-ui/index.html\nhttp $(minikube service spring-boot-demo --url | sed -n 2p)/info\nhttp $(minikube service spring-boot-demo --url | sed -n 2p)/health\n```\n\n### Monitor K8s resources\n\n```shell\nkubectl get nodes --no-headers | awk '{print $1}' | xargs -I {} sh -c 'echo {}; kubectl describe node {} | grep Allocated -A 5 | grep -ve Event -ve Allocated -ve percent -ve -- ; echo'\nkubectl top pod --all-namespaces\n```\n\n### TODO\n\n* Add Spring multi-layer support for the Docker image, be aware of the issue- https://github.com/docker/build-push-action/issues/79\n* Add GitHub workflow - see https://github.com/CodigoPraTodos/cursospratodos/blob/master/.github/workflows/ci-api.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandriykalashnykov%2Fspring-boot-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandriykalashnykov%2Fspring-boot-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandriykalashnykov%2Fspring-boot-demo/lists"}