mindol1004/getting-started
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactored gradle project structure

Browse Source
This commit is contained in:
Tom Hombergs
2018-01-08 22:32:52 +01:00
parent 387d9a5711
commit 2c775cdaa2
222 changed files with 12 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
spring-data/spring-data-rest-associations/.gitignore vendored Normal file
View File

@@ -0,0 +1,25 @@
.gradle
/build/
!gradle/wrapper/gradle-wrapper.jar
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
nbproject/private/
build/
nbbuild/
dist/
nbdist/
.nb-gradle/

13
spring-data/spring-data-rest-associations/README.md Normal file
View File

@@ -0,0 +1,13 @@
# Handling associations between entities with Spring Data Rest
This repo contains some example code that exposes some Spring Data repositories
via Spring Data REST to show how to handle relationships between JPA entities
via the REST API.
## Companion Blog Post
The companion blog post with more details can be found [here](https://reflectoring.io/relations-with-spring-data-rest/).
## Running the application
Simply run `gradlew bootrun` on Windows or `./gradlew.sh bootrun` on Unix.

31
spring-data/spring-data-rest-associations/build.gradle Normal file
View File

@@ -0,0 +1,31 @@
buildscript {
ext {
springBootVersion = '1.5.4.RELEASE'
}
repositories {
mavenCentral()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
}
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
repositories {
mavenLocal()
mavenCentral()
}
dependencies {
compile('org.springframework.boot:spring-boot-starter-data-jpa')
compile('org.springframework.boot:spring-boot-starter-data-rest')
compile('com.h2database:h2:1.4.196')
testCompile('org.springframework.boot:spring-boot-starter-test')
}

BIN
spring-data/spring-data-rest-associations/gradle/wrapper/gradle-wrapper.jar vendored Normal file
View File

Binary file not shown.

5
spring-data/spring-data-rest-associations/gradle/wrapper/gradle-wrapper.properties vendored Normal file
View File

@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-3.5.1-bin.zip

172
spring-data/spring-data-rest-associations/gradlew vendored Normal file
View File

@@ -0,0 +1,172 @@
#!/usr/bin/env sh
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn ( ) {
echo "$*"
}
die ( ) {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save ( ) {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"

84
spring-data/spring-data-rest-associations/gradlew.bat vendored Normal file
View File

@@ -0,0 +1,84 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

12
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/DemoApplication.java Normal file
View File

@@ -0,0 +1,12 @@
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}

84
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/Initializer.java Normal file
View File

@@ -0,0 +1,84 @@
package com.example.demo;
import com.example.demo.bidirectional.BidirectionalAddress;
import com.example.demo.bidirectional.BidirectionalAddressRepository;
import com.example.demo.bidirectional.BidirectionalCustomer;
import com.example.demo.bidirectional.BidirectionalCustomerRepository;
import com.example.demo.manytoone.ManyToOneAddress;
import com.example.demo.manytoone.ManyToOneAddressRepository;
import com.example.demo.manytoone.ManyToOneCustomer;
import com.example.demo.manytoone.ManyToOneCustomerRepository;
import com.example.demo.onetomany.OneToManyAddress;
import com.example.demo.onetomany.OneToManyAddressRepository;
import com.example.demo.onetomany.OneToManyCustomer;
import com.example.demo.onetomany.OneToManyCustomerRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;
@Component
public class Initializer implements ApplicationRunner {
private BidirectionalCustomerRepository biCustomerRepository;
private OneToManyCustomerRepository otmCustomerRepository;
private ManyToOneCustomerRepository mtoCustomerRepository;
private BidirectionalAddressRepository biAddressRepository;
private OneToManyAddressRepository otmAddressRepository;
private ManyToOneAddressRepository mtoAddressRepository;
@Autowired
public Initializer(BidirectionalCustomerRepository biCustomerRepository, OneToManyCustomerRepository otmCustomerRepository, ManyToOneCustomerRepository mtoCustomerRepository, BidirectionalAddressRepository biAddressRepository, OneToManyAddressRepository otmAddressRepository, ManyToOneAddressRepository mtoAddressRepository) {
this.biCustomerRepository = biCustomerRepository;
this.otmCustomerRepository = otmCustomerRepository;
this.mtoCustomerRepository = mtoCustomerRepository;
this.biAddressRepository = biAddressRepository;
this.otmAddressRepository = otmAddressRepository;
this.mtoAddressRepository = mtoAddressRepository;
}
@Override
public void run(ApplicationArguments args) throws Exception {
BidirectionalCustomer bidirectionalCustomer = new BidirectionalCustomer();
bidirectionalCustomer.setName("Tom");
biCustomerRepository.save(bidirectionalCustomer);
BidirectionalAddress bidirectionalAddress = new BidirectionalAddress();
bidirectionalAddress.setStreet("Elm Street");
biAddressRepository.save(bidirectionalAddress);
bidirectionalAddress = new BidirectionalAddress();
bidirectionalAddress.setStreet("High Street");
biAddressRepository.save(bidirectionalAddress);
OneToManyCustomer otmCustomer = new OneToManyCustomer();
otmCustomer.setName("Tom");
otmCustomerRepository.save(otmCustomer);
OneToManyAddress otmAddress = new OneToManyAddress();
otmAddress.setStreet("Elm Street");
otmAddressRepository.save(otmAddress);
otmAddress = new OneToManyAddress();
otmAddress.setStreet("High Street");
otmAddressRepository.save(otmAddress);
ManyToOneCustomer mtoCustomer = new ManyToOneCustomer();
mtoCustomer.setName("Tom");
mtoCustomerRepository.save(mtoCustomer);
ManyToOneAddress mtoAddress = new ManyToOneAddress();
mtoAddress.setStreet("Elm Street");
mtoAddressRepository.save(mtoAddress);
mtoAddress = new ManyToOneAddress();
mtoAddress.setStreet("High Street");
mtoAddressRepository.save(mtoAddress);
}
}

43
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/bidirectional/BidirectionalAddress.java Normal file
View File

@@ -0,0 +1,43 @@
package com.example.demo.bidirectional;
import javax.persistence.*;
@Entity
public class BidirectionalAddress {
@GeneratedValue
@Id
private Long id;
@Column
private String street;
@ManyToOne
private BidirectionalCustomer customer;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getStreet() {
return street;
}
public void setStreet(String street) {
this.street = street;
}
public BidirectionalCustomer getCustomer() {
return customer;
}
public void setCustomer(BidirectionalCustomer customer) {
this.customer = customer;
}
}

8
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/bidirectional/BidirectionalAddressRepository.java Normal file
View File

@@ -0,0 +1,8 @@
package com.example.demo.bidirectional;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(path = "addresses_bi")
public interface BidirectionalAddressRepository extends CrudRepository<BidirectionalAddress, Long> {
}

51
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/bidirectional/BidirectionalCustomer.java Normal file
View File

@@ -0,0 +1,51 @@
package com.example.demo.bidirectional;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;
@Entity
public class BidirectionalCustomer {
@Id
@GeneratedValue
private long id;
@Column
private String name;
@OneToMany(cascade = CascadeType.ALL, mappedBy = "customer")
private List<BidirectionalAddress> addresses = new ArrayList<>();
public void setId(long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public long getId() {
return id;
}
public List<BidirectionalAddress> getAddresses() {
return addresses;
}
public void setAddresses(List<BidirectionalAddress> addresses) {
this.addresses = addresses;
}
@PrePersist
@PreUpdate
public void updateAddressAssociation(){
for(BidirectionalAddress address : this.addresses){
address.setCustomer(this);
}
}
}

9
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/bidirectional/BidirectionalCustomerRepository.java Normal file
View File

@@ -0,0 +1,9 @@
package com.example.demo.bidirectional;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(path = "customers_bi")
public interface BidirectionalCustomerRepository extends CrudRepository<BidirectionalCustomer, Long> {
}

43
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/manytoone/ManyToOneAddress.java Normal file
View File

@@ -0,0 +1,43 @@
package com.example.demo.manytoone;
import javax.persistence.*;
@Entity
public class ManyToOneAddress {
@GeneratedValue
@Id
private Long id;
@Column
private String street;
@ManyToOne
private ManyToOneCustomer customer;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getStreet() {
return street;
}
public void setStreet(String street) {
this.street = street;
}
public ManyToOneCustomer getCustomer() {
return customer;
}
public void setCustomer(ManyToOneCustomer customer) {
this.customer = customer;
}
}

8
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/manytoone/ManyToOneAddressRepository.java Normal file
View File

@@ -0,0 +1,8 @@
package com.example.demo.manytoone;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(path = "addresses_mto")
public interface ManyToOneAddressRepository extends CrudRepository<ManyToOneAddress, Long> {
}

29
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/manytoone/ManyToOneCustomer.java Normal file
View File

@@ -0,0 +1,29 @@
package com.example.demo.manytoone;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;
@Entity
public class ManyToOneCustomer {
@Id
@GeneratedValue
private long id;
@Column
private String name;
public void setId(long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}

9
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/manytoone/ManyToOneCustomerRepository.java Normal file
View File

@@ -0,0 +1,9 @@
package com.example.demo.manytoone;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(path = "customers_mto")
public interface ManyToOneCustomerRepository extends CrudRepository<ManyToOneCustomer, Long> {
}

33
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/onetomany/OneToManyAddress.java Normal file
View File

@@ -0,0 +1,33 @@
package com.example.demo.onetomany;
import javax.persistence.*;
@Entity
public class OneToManyAddress {
@GeneratedValue
@Id
private Long id;
@Column
private String street;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getStreet() {
return street;
}
public void setStreet(String street) {
this.street = street;
}
}

8
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/onetomany/OneToManyAddressRepository.java Normal file
View File

@@ -0,0 +1,8 @@
package com.example.demo.onetomany;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(path = "addresses_otm")
public interface OneToManyAddressRepository extends CrudRepository<OneToManyAddress, Long> {
}

40
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/onetomany/OneToManyCustomer.java Normal file
View File

@@ -0,0 +1,40 @@
package com.example.demo.onetomany;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;
@Entity
public class OneToManyCustomer {
@Id
@GeneratedValue
private long id;
@Column
private String name;
@OneToMany(cascade = CascadeType.ALL)
private List<OneToManyAddress> addresses = new ArrayList<>();
public void setId(long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public List<OneToManyAddress> getAddresses() {
return addresses;
}
public void setAddresses(List<OneToManyAddress> addresses) {
this.addresses = addresses;
}
}

9
spring-data/spring-data-rest-associations/src/main/java/com/example/demo/onetomany/OneToManyCustomerRepository.java Normal file
View File

@@ -0,0 +1,9 @@
package com.example.demo.onetomany;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(path = "customers_otm")
public interface OneToManyCustomerRepository extends CrudRepository<OneToManyCustomer, Long> {
}

7
spring-data/spring-data-rest-associations/src/main/resources/application.properties Normal file
View File

@@ -0,0 +1,7 @@
spring.datasource.url=jdbc:h2:mem:AZ;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.h2.console.enabled=true
logging.level.org.hibernate.SQL=DEBUG

16
spring-data/spring-data-rest-associations/src/test/java/com/example/demo/DemoApplicationTests.java Normal file
View File

@@ -0,0 +1,16 @@
package com.example.demo;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
@Test
public void contextLoads() {
}
}

25
spring-data/spring-data-rest-springfox/.gitignore vendored Normal file
View File

@@ -0,0 +1,25 @@
.gradle
/build/
!gradle/wrapper/gradle-wrapper.jar
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
nbproject/private/
build/
nbbuild/
dist/
nbdist/
.nb-gradle/

12
spring-data/spring-data-rest-springfox/README.md Normal file
View File

@@ -0,0 +1,12 @@
# Documenting a Spring Data REST API with Springfox and Swagger
This repo contains some example code that exposes some Spring Data repositories
via Spring Data REST and creates a documentation of that API using Springfox.
## Companion Blog Post
The companion blog post with more details can be found [here](https://reflectoring.io/documenting-spring-data-rest-api-with-springfox/).
## Running the application
Simply run `gradlew bootrun` on Windows or `./gradlew.sh bootrun` on Unix.

39
spring-data/spring-data-rest-springfox/build.gradle Normal file
View File

@@ -0,0 +1,39 @@
buildscript {
ext {
springBootVersion = '1.5.4.RELEASE'
}
repositories {
mavenCentral()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
}
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
repositories {
mavenLocal()
mavenCentral()
maven { url 'http://oss.jfrog.org/artifactory/oss-snapshot-local/' }
}
dependencies {
compile('org.springframework.boot:spring-boot-starter-data-jpa')
compile('org.springframework.boot:spring-boot-starter-data-rest')
compile('io.springfox:springfox-data-rest:2.7.1-SNAPSHOT')
compile('io.springfox:springfox-swagger2:2.7.1-SNAPSHOT')
compile('io.springfox:springfox-swagger-ui:2.7.1-SNAPSHOT')
compile('com.h2database:h2:1.4.196')
testCompile('org.springframework.boot:spring-boot-starter-test')
}
bootRun{
jvmArgs = ["-Xdebug", "-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"]
}

BIN
spring-data/spring-data-rest-springfox/gradle/wrapper/gradle-wrapper.jar vendored Normal file
View File

Binary file not shown.

5
spring-data/spring-data-rest-springfox/gradle/wrapper/gradle-wrapper.properties vendored Normal file
View File

@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-bin.zip

172
spring-data/spring-data-rest-springfox/gradlew vendored Normal file
View File

@@ -0,0 +1,172 @@
#!/usr/bin/env sh
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn ( ) {
echo "$*"
}
die ( ) {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save ( ) {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"

84
spring-data/spring-data-rest-springfox/gradlew.bat vendored Normal file
View File

@@ -0,0 +1,84 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

50
spring-data/spring-data-rest-springfox/src/main/java/com/example/demo/Address.java Normal file
View File

@@ -0,0 +1,50 @@
package com.example.demo;
import com.fasterxml.jackson.annotation.JsonIgnore;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import javax.persistence.*;
@ApiModel("an address")
@Entity
public class Address {
@GeneratedValue
@Id
@ApiModelProperty(hidden = true)
private Long id;
@Column
private String street;
@ManyToOne
@ApiModelProperty(hidden = true)
private Customer customer;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getStreet() {
return street;
}
public void setStreet(String street) {
this.street = street;
}
public Customer getCustomer() {
return customer;
}
public void setCustomer(Customer customer) {
this.customer = customer;
}
}

23
spring-data/spring-data-rest-springfox/src/main/java/com/example/demo/AddressRepository.java Normal file
View File

@@ -0,0 +1,23 @@
package com.example.demo;
import io.swagger.annotations.*;
import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
import java.util.List;
@Api(tags = "Address Entity")
@RepositoryRestResource(path = "addresses")
public interface AddressRepository extends PagingAndSortingRepository<Address, Long> {
@ApiOperation("find all Addresses that are associated with a given Customer")
List<Address> findByCustomerId(@Param("customerId") @ApiParam(name = "customerId", value = "ID of the customer", type = "body") Long customerId);
@Override
@SuppressWarnings("unchecked")
@ApiOperation("saves a new Address")
@ApiResponses({@ApiResponse(code = 201, message = "Created", response = Address.class)})
Address save(Address address);
}

29
spring-data/spring-data-rest-springfox/src/main/java/com/example/demo/Customer.java Normal file
View File

@@ -0,0 +1,29 @@
package com.example.demo;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;
@Entity
public class Customer {
@Id
@GeneratedValue
private long id;
@Column
private String name;
public void setId(long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}

9
spring-data/spring-data-rest-springfox/src/main/java/com/example/demo/CustomerRepository.java Normal file
View File

@@ -0,0 +1,9 @@
package com.example.demo;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(path = "customers")
public interface CustomerRepository extends CrudRepository<Customer, Long> {
}

17
spring-data/spring-data-rest-springfox/src/main/java/com/example/demo/DemoApplication.java Normal file
View File

@@ -0,0 +1,17 @@
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Import;
import springfox.documentation.spring.data.rest.configuration.SpringDataRestConfiguration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@Import(SpringDataRestConfiguration.class)
@EnableSwagger2
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}

36
spring-data/spring-data-rest-springfox/src/main/java/com/example/demo/Initializer.java Normal file
View File

@@ -0,0 +1,36 @@
package com.example.demo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;
@Component
public class Initializer implements ApplicationRunner {
private CustomerRepository mtoCustomerRepository;
private AddressRepository mtoAddressRepository;
@Autowired
public Initializer(CustomerRepository mtoCustomerRepository, AddressRepository mtoAddressRepository) {
this.mtoCustomerRepository = mtoCustomerRepository;
this.mtoAddressRepository = mtoAddressRepository;
}
@Override
public void run(ApplicationArguments args) throws Exception {
Customer mtoCustomer = new Customer();
mtoCustomer.setName("Tom");
mtoCustomerRepository.save(mtoCustomer);
Address mtoAddress = new Address();
mtoAddress.setStreet("Elm Street");
mtoAddressRepository.save(mtoAddress);
mtoAddress = new Address();
mtoAddress.setStreet("High Street");
mtoAddressRepository.save(mtoAddress);
}
}

21
spring-data/spring-data-rest-springfox/src/main/java/com/example/demo/SpringfoxConfiguration.java Normal file
View File

@@ -0,0 +1,21 @@
package com.example.demo;
import com.google.common.collect.Lists;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Tag;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SpringfoxConfiguration {
@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2)
.tags(new Tag("Address Entity", "Repository for Address entities"))
.apiInfo(new ApiInfo("Customer Service API", "REST API of the Customer Service", "v42", null, null, null, null, Lists.newArrayList()));
}
}

7
spring-data/spring-data-rest-springfox/src/main/resources/application.properties Normal file
View File

@@ -0,0 +1,7 @@
spring.datasource.url=jdbc:h2:mem:AZ;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.h2.console.enabled=true
logging.level.org.hibernate.SQL=DEBUG