├── .github ├── dependabot.yml └── workflows │ ├── gradle.yml │ └── update-gradle-wrapper.yml ├── .gitignore ├── Dockerfile ├── Jenkinsfile ├── Jenkinsfile-aws ├── Jenkinsfile-docker ├── README.md ├── build.gradle ├── ecs.yml ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── main └── java │ └── com │ └── tomgregory │ ├── ThemeParkApplication.java │ ├── controller │ └── ThemeParkRideController.java │ ├── entity │ └── ThemeParkRide.java │ └── repository │ └── ThemeParkRideRepository.java └── test └── java └── com └── tomgregory └── ThemeParkApplicationIT.java /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "gradle" 4 | directory: "/" 5 | schedule: 6 | interval: "monthly" 7 | - package-ecosystem: "github-actions" 8 | directory: "/" 9 | schedule: 10 | interval: "monthly" 11 | -------------------------------------------------------------------------------- /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: [ master ] 5 | pull_request: 6 | branches: [ master ] 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v3 12 | - name: Set up JDK 13 | uses: actions/setup-java@v3 14 | with: 15 | java-version: 17 16 | distribution: 'adopt' 17 | cache: gradle 18 | - name: Grant execute permission for gradlew 19 | run: chmod +x gradlew 20 | - name: Build with Gradle 21 | run: ./gradlew build -------------------------------------------------------------------------------- /.github/workflows/update-gradle-wrapper.yml: -------------------------------------------------------------------------------- 1 | name: Update Gradle Wrapper 2 | on: 3 | schedule: 4 | - cron: "0 6 * * 1" 5 | jobs: 6 | update-gradle-wrapper: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v3 10 | - name: set up JDK 17 11 | uses: actions/setup-java@v3 12 | with: 13 | java-version: '17' 14 | distribution: 'adopt' 15 | cache: gradle 16 | - name: Update Gradle Wrapper 17 | uses: gradle-update/update-gradle-wrapper-action@v1 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle/ 2 | .idea/ 3 | build/ 4 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM openjdk:17 2 | ARG JAR_FILE 3 | COPY ${JAR_FILE} app.jar 4 | ENTRYPOINT ["java", "-jar", "/app.jar"] -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent any 3 | 4 | triggers { 5 | pollSCM '* * * * *' 6 | } 7 | stages { 8 | stage('Build') { 9 | steps { 10 | sh './gradlew assemble' 11 | } 12 | } 13 | stage('Test') { 14 | steps { 15 | sh './gradlew test' 16 | } 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /Jenkinsfile-aws: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent any 3 | 4 | triggers { 5 | pollSCM '* * * * *' 6 | } 7 | stages { 8 | stage('Build') { 9 | steps { 10 | sh './gradlew assemble' 11 | } 12 | } 13 | stage('Test') { 14 | steps { 15 | sh './gradlew test' 16 | } 17 | } 18 | stage('Build Docker image') { 19 | steps { 20 | sh './gradlew docker' 21 | } 22 | } 23 | stage('Push Docker image') { 24 | environment { 25 | DOCKER_HUB_LOGIN = credentials('docker-hub') 26 | } 27 | steps { 28 | sh 'docker login --username=$DOCKER_HUB_LOGIN_USR --password=$DOCKER_HUB_LOGIN_PSW' 29 | sh './gradlew dockerPush -PdockerHubUsername=$DOCKER_HUB_LOGIN_USR' 30 | } 31 | } 32 | stage('Deploy to AWS') { 33 | environment { 34 | DOCKER_HUB_LOGIN = credentials('docker-hub') 35 | } 36 | steps { 37 | withAWS(credentials: 'aws-credentials', region: env.AWS_REGION) { 38 | sh './gradlew awsCfnMigrateStack awsCfnWaitStackComplete -PsubnetId=$SUBNET_ID -PdockerHubUsername=$DOCKER_HUB_LOGIN_USR -Pregion=$AWS_REGION' 39 | } 40 | } 41 | } 42 | } 43 | } -------------------------------------------------------------------------------- /Jenkinsfile-docker: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent any 3 | 4 | triggers { 5 | pollSCM '* * * * *' 6 | } 7 | stages { 8 | stage('Build') { 9 | steps { 10 | sh './gradlew assemble' 11 | } 12 | } 13 | stage('Test') { 14 | steps { 15 | sh './gradlew test' 16 | } 17 | } 18 | stage('Build Docker image') { 19 | steps { 20 | sh './gradlew docker' 21 | } 22 | } 23 | stage('Push Docker image') { 24 | environment { 25 | DOCKER_HUB_LOGIN = credentials('docker-hub') 26 | } 27 | steps { 28 | sh 'docker login --username=$DOCKER_HUB_LOGIN_USR --password=$DOCKER_HUB_LOGIN_PSW' 29 | sh './gradlew dockerPush' 30 | } 31 | } 32 | } 33 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![CI](https://github.com/tkgregory/spring-boot-api-example/actions/workflows/gradle.yml/badge.svg)](https://github.com/tkgregory/spring-boot-api-example/actions/workflows/gradle.yml) 2 | 3 | ## Overview 4 | 5 | An example project to demonstrate: 6 | 7 | * how to create a Spring Boot REST API ([article](https://tomgregory.com/building-a-spring-boot-application-in-jenkins/) | [video](https://youtu.be/sCcuUMn1vdM)) 8 | * how to run Spring Boot in Docker and publish to Docker Hub ([article](https://tomgregory.com/building-a-spring-boot-application-in-docker-and-jenkins/) | [video](https://youtu.be/Kc3Vw5vk1Lw)) 9 | * how to deploy the Spring Boot application to AWS with CloudFormation ([article](https://tomgregory.com/deploying-a-spring-boot-application-into-aws-with-jenkins/) | [video](https://youtu.be/5xh0nAYeZNc)) 10 | 11 | ## Pre-requisites 12 | 13 | * JDK 17+ 14 | * Docker 15 | 16 | ## Building 17 | 18 | ### Testing 19 | 20 | `./gradlew test` 21 | 22 | ### Building (no tests) 23 | 24 | `./gradlew assemble` 25 | 26 | ### Building (with tests) 27 | 28 | `./gradlew build` 29 | 30 | ### Running in Docker 31 | 32 | `./gradlew assemble docker dockerRun` 33 | 34 | ### Stopping Docker container 35 | 36 | `./gradlew dockerStop` 37 | 38 | ### Deploying to AWS 39 | 40 | `./gradlew awsCfnMigrateStack awsCfnWaitStackComplete -PsubnetId= -Pregion=` 41 | 42 | ### Deleting AWS deployment 43 | 44 | `./gradlew awsCfnDeleteStack awsCfnWaitStackComplete` 45 | 46 | ## Using API 47 | 48 | * get all rides - GET [/ride](http://localhost:8080/ride) to get a list of all the rides 49 | * get specific ride - GET [/ride/${id}](http://localhost:8080/ride/1) to get a specific ride 50 | * create ride - POST JSON to [/ride](http://localhost:8080/ride) to create a new ride 51 | (see [article](https://tomgregory.com/building-a-spring-boot-application-in-jenkins/#2_Trying_out_our_Spring_Boot_application) for full details) 52 | 53 | ## Need further support? 54 | Contact me if you need help at tom@tomgregory.com. 55 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'java' 3 | id 'io.spring.dependency-management' version "1.1.0" 4 | id 'org.springframework.boot' version '3.0.1' 5 | id 'pl.allegro.tech.build.axion-release' version '1.14.3' 6 | id 'com.palantir.docker' version '0.34.0' 7 | id 'com.palantir.docker-run' version '0.34.0' 8 | id 'jp.classmethod.aws.reboot.cloudformation' version '0.45' 9 | } 10 | 11 | version = scmVersion.version 12 | 13 | repositories { 14 | mavenCentral() 15 | } 16 | 17 | dependencies { 18 | implementation 'org.springframework.boot:spring-boot-starter-web' 19 | implementation 'org.springframework.boot:spring-boot-starter-validation' 20 | implementation 'org.springframework.boot:spring-boot-starter-actuator' 21 | implementation 'org.springframework.boot:spring-boot-starter-data-jpa' 22 | implementation 'org.springframework.boot:spring-boot-devtools' 23 | implementation group: 'com.h2database', name: 'h2', version: '2.1.214' 24 | 25 | compileOnly 'org.projectlombok:lombok:1.18.24' 26 | annotationProcessor 'org.projectlombok:lombok:1.18.24' 27 | 28 | testImplementation 'org.springframework.boot:spring-boot-starter-test' 29 | } 30 | 31 | test { 32 | useJUnitPlatform() 33 | } 34 | 35 | String dockerHubUsernameProperty = findProperty('dockerHubUsername') ?: 'tkgregory' 36 | String imageName = "${dockerHubUsernameProperty}/spring-boot-api-example:$version" 37 | 38 | docker { 39 | name imageName 40 | files "build/libs/${bootJar.archiveFileName.get()}" 41 | buildArgs([JAR_FILE: bootJar.archiveFileName.get()]) 42 | } 43 | 44 | dockerRun { 45 | name project.name 46 | image imageName 47 | ports '8080:8080' 48 | clean true 49 | } 50 | 51 | aws { 52 | region = findProperty('region') ?: 'us-east-1' 53 | } 54 | 55 | cloudFormation { 56 | stackName "$project.name-stack" 57 | stackParams([ 58 | SubnetID: findProperty('subnetId') ?: '', 59 | ServiceName: project.name, 60 | ServiceVersion: project.version, 61 | DockerHubUsername: dockerHubUsernameProperty 62 | ]) 63 | templateFile project.file("ecs.yml") 64 | } 65 | 66 | java { 67 | toolchain { 68 | languageVersion = JavaLanguageVersion.of(17) 69 | } 70 | } 71 | 72 | task('doStuff', type: Copy) { 73 | println 'congiguring task' 74 | doFirst { 75 | println 'running task' 76 | } 77 | } -------------------------------------------------------------------------------- /ecs.yml: -------------------------------------------------------------------------------- 1 | AWSTemplateFormatVersion: "2010-09-09" 2 | Parameters: 3 | SubnetID: 4 | Type: String 5 | ServiceName: 6 | Type: String 7 | ServiceVersion: 8 | Type: String 9 | DockerHubUsername: 10 | Type: String 11 | Resources: 12 | Cluster: 13 | Type: AWS::ECS::Cluster 14 | Properties: 15 | ClusterName: deployment-example-cluster 16 | ServiceSecurityGroup: 17 | Type: AWS::EC2::SecurityGroup 18 | Properties: 19 | GroupName: ServiceSecurityGroup 20 | GroupDescription: Security group for service 21 | SecurityGroupIngress: 22 | - IpProtocol: tcp 23 | FromPort: 8080 24 | ToPort: 8080 25 | CidrIp: 0.0.0.0/0 26 | TaskDefinition: 27 | Type: AWS::ECS::TaskDefinition 28 | Properties: 29 | Family: !Sub ${ServiceName}-task 30 | Cpu: 256 31 | Memory: 512 32 | NetworkMode: awsvpc 33 | ContainerDefinitions: 34 | - Name: !Sub ${ServiceName}-container 35 | Image: !Sub ${DockerHubUsername}/${ServiceName}:${ServiceVersion} 36 | PortMappings: 37 | - ContainerPort: 8080 38 | RequiresCompatibilities: 39 | - EC2 40 | - FARGATE 41 | Service: 42 | Type: AWS::ECS::Service 43 | Properties: 44 | ServiceName: !Sub ${ServiceName}-service 45 | Cluster: !Ref Cluster 46 | TaskDefinition: !Ref TaskDefinition 47 | DesiredCount: 1 48 | LaunchType: FARGATE 49 | NetworkConfiguration: 50 | AwsvpcConfiguration: 51 | AssignPublicIp: ENABLED 52 | Subnets: 53 | - !Ref SubnetID 54 | SecurityGroups: 55 | - !GetAtt ServiceSecurityGroup.GroupId -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jenkins-hero/spring-boot-api-example/a6b3bb8338051d551977ecc47be36f0bd84ac380/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionSha256Sum=7ba68c54029790ab444b39d7e293d3236b2632631fb5f2e012bb28b4ff669e4b 4 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip 5 | networkTimeout=10000 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 147 | # shellcheck disable=SC3045 148 | MAX_FD=$( ulimit -H -n ) || 149 | warn "Could not query maximum file descriptor limit" 150 | esac 151 | case $MAX_FD in #( 152 | '' | soft) :;; #( 153 | *) 154 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 155 | # shellcheck disable=SC3045 156 | ulimit -n "$MAX_FD" || 157 | warn "Could not set maximum file descriptor limit to $MAX_FD" 158 | esac 159 | fi 160 | 161 | # Collect all arguments for the java command, stacking in reverse order: 162 | # * args from the command line 163 | # * the main class name 164 | # * -classpath 165 | # * -D...appname settings 166 | # * --module-path (only if needed) 167 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 168 | 169 | # For Cygwin or MSYS, switch paths to Windows format before running java 170 | if "$cygwin" || "$msys" ; then 171 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 172 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 173 | 174 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 175 | 176 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 177 | for arg do 178 | if 179 | case $arg in #( 180 | -*) false ;; # don't mess with options #( 181 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 182 | [ -e "$t" ] ;; #( 183 | *) false ;; 184 | esac 185 | then 186 | arg=$( cygpath --path --ignore --mixed "$arg" ) 187 | fi 188 | # Roll the args list around exactly as many times as the number of 189 | # args, so each arg winds up back in the position where it started, but 190 | # possibly modified. 191 | # 192 | # NB: a `for` loop captures its iteration list before it begins, so 193 | # changing the positional parameters here affects neither the number of 194 | # iterations, nor the values presented in `arg`. 195 | shift # remove old arg 196 | set -- "$@" "$arg" # push replacement arg 197 | done 198 | fi 199 | 200 | # Collect all arguments for the java command; 201 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 202 | # shell script including quotes and variable substitutions, so put them in 203 | # double quotes to make sure that they get re-expanded; and 204 | # * put everything else in single quotes, so that it's not re-expanded. 205 | 206 | set -- \ 207 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 208 | -classpath "$CLASSPATH" \ 209 | org.gradle.wrapper.GradleWrapperMain \ 210 | "$@" 211 | 212 | # Stop when "xargs" is not available. 213 | if ! command -v xargs >/dev/null 2>&1 214 | then 215 | die "xargs is not available" 216 | fi 217 | 218 | # Use "xargs" to parse quoted args. 219 | # 220 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 221 | # 222 | # In Bash we could simply go: 223 | # 224 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 225 | # set -- "${ARGS[@]}" "$@" 226 | # 227 | # but POSIX shell has neither arrays nor command substitution, so instead we 228 | # post-process each arg (as a line of input to sed) to backslash-escape any 229 | # character that might be a shell metacharacter, then use eval to reverse 230 | # that process (while maintaining the separation between arguments), and wrap 231 | # the whole thing up as a single "set" statement. 232 | # 233 | # This will of course break if any of these variables contains a newline or 234 | # an unmatched quote. 235 | # 236 | 237 | eval "set -- $( 238 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 239 | xargs -n1 | 240 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 241 | tr '\n' ' ' 242 | )" '"$@"' 243 | 244 | exec "$JAVACMD" "$@" 245 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'spring-boot-api-example' 2 | 3 | -------------------------------------------------------------------------------- /src/main/java/com/tomgregory/ThemeParkApplication.java: -------------------------------------------------------------------------------- 1 | package com.tomgregory; 2 | 3 | import com.tomgregory.entity.ThemeParkRide; 4 | import com.tomgregory.repository.ThemeParkRideRepository; 5 | import org.springframework.boot.CommandLineRunner; 6 | import org.springframework.boot.SpringApplication; 7 | import org.springframework.boot.autoconfigure.SpringBootApplication; 8 | import org.springframework.context.annotation.Bean; 9 | 10 | @SpringBootApplication 11 | public class ThemeParkApplication { 12 | public static void main(String[] args) { 13 | SpringApplication.run(ThemeParkApplication.class); 14 | } 15 | 16 | @Bean 17 | public CommandLineRunner sampleData(ThemeParkRideRepository repository) { 18 | return (args) -> { 19 | repository.save(new ThemeParkRide("Rollercoaster", "Train ride that speeds you along.", 5, 3)); 20 | repository.save(new ThemeParkRide("Log flume", "Boat ride with plenty of splashes.", 3, 2)); 21 | repository.save(new ThemeParkRide("Teacups", "Spinning ride in a giant tea-cup.", 2, 4)); 22 | }; 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/com/tomgregory/controller/ThemeParkRideController.java: -------------------------------------------------------------------------------- 1 | package com.tomgregory.controller; 2 | 3 | import com.tomgregory.entity.ThemeParkRide; 4 | import com.tomgregory.repository.ThemeParkRideRepository; 5 | import org.springframework.http.HttpStatus; 6 | import org.springframework.http.MediaType; 7 | import org.springframework.web.bind.annotation.*; 8 | import org.springframework.web.server.ResponseStatusException; 9 | 10 | import jakarta.validation.Valid; 11 | 12 | @RestController 13 | public class ThemeParkRideController { 14 | private final ThemeParkRideRepository themeParkRideRepository; 15 | 16 | public ThemeParkRideController(ThemeParkRideRepository themeParkRideRepository) { 17 | this.themeParkRideRepository = themeParkRideRepository; 18 | } 19 | 20 | @GetMapping(value = "/ride", produces = MediaType.APPLICATION_JSON_VALUE) 21 | public Iterable getRides() { 22 | return themeParkRideRepository.findAll(); 23 | } 24 | 25 | @GetMapping(value = "/ride/{id}", produces = MediaType.APPLICATION_JSON_VALUE) 26 | public ThemeParkRide getRide(@PathVariable long id){ 27 | return themeParkRideRepository.findById(id).orElseThrow(() -> new ResponseStatusException(HttpStatus.NOT_FOUND, String.format("Invalid ride id %s", id))); 28 | } 29 | 30 | @PostMapping(value = "/ride", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE) 31 | public ThemeParkRide createRide(@Valid @RequestBody ThemeParkRide themeParkRide) { 32 | return themeParkRideRepository.save(themeParkRide); 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/com/tomgregory/entity/ThemeParkRide.java: -------------------------------------------------------------------------------- 1 | package com.tomgregory.entity; 2 | 3 | import lombok.Getter; 4 | import lombok.NoArgsConstructor; 5 | import lombok.ToString; 6 | 7 | import jakarta.persistence.Entity; 8 | import jakarta.persistence.GeneratedValue; 9 | import jakarta.persistence.GenerationType; 10 | import jakarta.persistence.Id; 11 | import jakarta.validation.constraints.NotEmpty; 12 | 13 | @Entity 14 | @Getter 15 | @ToString 16 | @NoArgsConstructor 17 | public class ThemeParkRide { 18 | @Id 19 | @GeneratedValue(strategy=GenerationType.AUTO) 20 | private Long id; 21 | @NotEmpty 22 | private String name; 23 | @NotEmpty 24 | private String description; 25 | private int thrillFactor; 26 | private int vomitFactor; 27 | 28 | public ThemeParkRide(String name, String description, int thrillFactor, int vomitFactor) { 29 | this.name = name; 30 | this.description = description; 31 | this.thrillFactor = thrillFactor; 32 | this.vomitFactor = vomitFactor; 33 | } 34 | 35 | } -------------------------------------------------------------------------------- /src/main/java/com/tomgregory/repository/ThemeParkRideRepository.java: -------------------------------------------------------------------------------- 1 | package com.tomgregory.repository; 2 | 3 | import com.tomgregory.entity.ThemeParkRide; 4 | import org.springframework.data.repository.CrudRepository; 5 | import org.springframework.stereotype.Repository; 6 | 7 | import java.util.List; 8 | 9 | @Repository 10 | public interface ThemeParkRideRepository extends CrudRepository { 11 | List findByName(String name); 12 | } 13 | -------------------------------------------------------------------------------- /src/test/java/com/tomgregory/ThemeParkApplicationIT.java: -------------------------------------------------------------------------------- 1 | package com.tomgregory; 2 | 3 | import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; 4 | 5 | import org.junit.jupiter.api.Test; 6 | import org.junit.jupiter.api.extension.ExtendWith; 7 | import org.springframework.beans.factory.annotation.Autowired; 8 | import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; 9 | import org.springframework.boot.test.context.SpringBootTest; 10 | import org.springframework.http.MediaType; 11 | import org.springframework.test.context.junit.jupiter.SpringExtension; 12 | import org.springframework.test.web.servlet.MockMvc; 13 | import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; 14 | 15 | @ExtendWith( SpringExtension.class) 16 | @SpringBootTest 17 | @AutoConfigureMockMvc 18 | public class ThemeParkApplicationIT { 19 | 20 | @Autowired 21 | private MockMvc mockMvc; 22 | 23 | @Test 24 | public void getsAllRides() throws Exception { 25 | mockMvc.perform(MockMvcRequestBuilders.get("/ride") 26 | .accept(MediaType.APPLICATION_JSON)) 27 | .andExpect(status().isOk()) 28 | .andReturn(); 29 | } 30 | 31 | @Test 32 | public void getsSingleRide() throws Exception { 33 | mockMvc.perform(MockMvcRequestBuilders.get("/ride/1") 34 | .accept(MediaType.APPLICATION_JSON)) 35 | .andExpect(status().isOk()) 36 | .andReturn(); 37 | } 38 | 39 | @Test 40 | public void returnsNotFoundForInvalidSingleRide() throws Exception { 41 | mockMvc.perform(MockMvcRequestBuilders.get("/ride/4") 42 | .accept(MediaType.APPLICATION_JSON)) 43 | .andExpect(status().isNotFound()) 44 | .andReturn(); 45 | } 46 | 47 | @Test 48 | public void addsNewRide() throws Exception { 49 | String newRide = "{\"name\":\"Monorail\",\"description\":\"Sedate travelling ride.\",\"thrillFactor\":2,\"vomitFactor\":1}"; 50 | mockMvc.perform(MockMvcRequestBuilders.post("/ride") 51 | .contentType(MediaType.APPLICATION_JSON) 52 | .content(newRide) 53 | .accept(MediaType.APPLICATION_JSON)) 54 | .andExpect(status().isOk()) 55 | .andReturn(); 56 | } 57 | } 58 | --------------------------------------------------------------------------------