SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from 1.0.x to gh-pages

Browse Source
This commit is contained in:
buildmaster
2016-12-14 21:10:44 +00:00
parent 7217185eb4
commit 56aa437013
8 changed files with 49 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
1.0.x/spring-cloud-contract-maven-plugin/complex-content.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-07
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-14
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20161207" />
<meta name="Date-Revision-yyyymmdd" content="20161214" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Verifier Maven Plugin &#x2013; </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -104,7 +104,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-12-07
<li id="publishDate">Last Published: 2016-12-14
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.0.3.BUILD-SNAPSHOT

6
1.0.x/spring-cloud-contract-maven-plugin/complex.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-07
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-14
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20161207" />
<meta name="Date-Revision-yyyymmdd" content="20161214" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Verifier Maven Plugin &#x2013; </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -104,7 +104,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-12-07
<li id="publishDate">Last Published: 2016-12-14
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.0.3.BUILD-SNAPSHOT

6
1.0.x/spring-cloud-contract-maven-plugin/index.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-07
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-14
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20161207" />
<meta name="Date-Revision-yyyymmdd" content="20161214" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Verifier Maven Plugin &#x2013; </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -104,7 +104,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-12-07
<li id="publishDate">Last Published: 2016-12-14
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.0.3.BUILD-SNAPSHOT

6
1.0.x/spring-cloud-contract-maven-plugin/junit.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-07
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-14
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20161207" />
<meta name="Date-Revision-yyyymmdd" content="20161214" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Verifier Maven Plugin &#x2013; </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -104,7 +104,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-12-07
<li id="publishDate">Last Published: 2016-12-14
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.0.3.BUILD-SNAPSHOT

6
1.0.x/spring-cloud-contract-maven-plugin/sitemap.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-07
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-14
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20161207" />
<meta name="Date-Revision-yyyymmdd" content="20161214" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Verifier Maven Plugin &#x2013; Sitemap</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -104,7 +104,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-12-07
<li id="publishDate">Last Published: 2016-12-14
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.0.3.BUILD-SNAPSHOT

6
1.0.x/spring-cloud-contract-maven-plugin/spock.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-07
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-14
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20161207" />
<meta name="Date-Revision-yyyymmdd" content="20161214" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Verifier Maven Plugin &#x2013; </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -104,7 +104,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-12-07
<li id="publishDate">Last Published: 2016-12-14
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.0.3.BUILD-SNAPSHOT

6
1.0.x/spring-cloud-contract-maven-plugin/usage.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-07
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-12-14
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20161207" />
<meta name="Date-Revision-yyyymmdd" content="20161214" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Verifier Maven Plugin &#x2013; </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -104,7 +104,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-12-07
<li id="publishDate">Last Published: 2016-12-14
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.0.3.BUILD-SNAPSHOT

54
1.0.x/spring-cloud-contract.html
View File

@@ -1599,36 +1599,38 @@ public void shouldBeRejectedDueToAbnormalLoanAmount() {
<pre class="highlight"><code class="language-groovy" data-lang="groovy">package contracts
org.springframework.cloud.contract.spec.Contract.make {
request { // (1)
method 'PUT' // (2)
url '/fraudcheck' // (3)
body([ // (4)
clientId: value(consumer(regex('[0-9]{10}'))),
loanAmount: 99999
])
headers { // (5)
contentType("application/vnd.fraud.v1+json")
}
}
response { // (6)
status 200 // (7)
body([ // (8)
fraudCheckStatus: "FRAUD",
rejectionReason: "Amount too high"
])
headers { // (9)
contentType("application/vnd.fraud.v1+json")
}
}
request { // (1)
method 'PUT' // (2)
url '/fraudcheck' // (3)
body([ // (4)
clientId: $(regex('[0-9]{10}')),
loanAmount: 99999
])
headers { // (5)
contentType('application/vnd.fraud.v1+json')
}
}
response { // (6)
status 200 // (7)
body([ // (8)
fraudCheckStatus: "FRAUD",
rejectionReason: "Amount too high"
])
headers { // (9)
contentType('application/vnd.fraud.v1+json')
}
}
}
/*
Since we don't want to force on the user to hardcode values of fields that are dynamic
(timestamps, database ids etc.), one can provide parametrize those entries by using the
`value(consumer(...), producer(...))` method. That way what's present in the `consumer`
section will end up in the produced stub. What's there in the `producer` will end up in the
autogenerated test. If you provide only the regular expression side without the concrete
value then Spring Cloud Contract will generate one for you.
(timestamps, database ids etc.), one can parametrize those entries. If you wrap your field's
value in a `$(...)` or `value(...)` and provide a dynamic value of a field then
the concrete value will be generated for you. If you want to be really explicit about
which side gets which value you can do that by using the `value(consumer(...), producer(...))` notation.
That way what's present in the `consumer` section will end up in the produced stub. What's
there in the `producer` will end up in the autogenerated test. If you provide only the
regular expression side without the concrete value then Spring Cloud Contract will generate one for you.
From the Consumer perspective, when shooting a request in the integration test: