Updated documentation for generating Spring REST Docs snippets (#648)

* Updated documentation with examples how to generate Spring REST Docs snippets from the generated tests.

fixes gh-613
This commit is contained in:
Tim Ysewyn
2018-05-09 07:57:13 +02:00
committed by Marcin Grzejszczak
parent 17327462ad
commit 8c5f2f5567
8 changed files with 256 additions and 6 deletions

View File

@@ -21,6 +21,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
<spring-cloud-contract.version>2.0.0.BUILD-SNAPSHOT</spring-cloud-contract.version>
<spring.cloud.contract.verifier.skip>true</spring.cloud.contract.verifier.skip>
</properties>
<dependencies>
@@ -43,16 +44,23 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.restdocs</groupId>
<artifactId>spring-restdocs-mockmvc</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-contract-stub-runner</artifactId>
<scope>test</scope>
</dependency>
<!-- tag::dependencies[] -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-contract-verifier</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.restdocs</groupId>
<artifactId>spring-restdocs-mockmvc</artifactId>
<optional>true</optional>
</dependency>
<!-- end::dependencies[] -->
</dependencies>
<dependencyManagement>
@@ -113,6 +121,26 @@
</execution>
</executions>
</plugin>
<!-- tag::plugin[] -->
<plugin>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-contract-maven-plugin</artifactId>
<version>${spring-cloud-contract.version}</version>
<extensions>true</extensions>
<configuration>
<baseClassMappings>
<baseClassMapping>
<contractPackageRegex>.*standalone.*</contractPackageRegex>
<baseClassFQN>com.example.fraud.FraudBaseWithStandaloneSetup</baseClassFQN>
</baseClassMapping>
<baseClassMapping>
<contractPackageRegex>.*webapp.*</contractPackageRegex>
<baseClassFQN>com.example.fraud.FraudBaseWithWebAppSetup</baseClassFQN>
</baseClassMapping>
</baseClassMappings>
</configuration>
</plugin>
<!-- end::plugin[] -->
</plugins>
</build>