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

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
Marcin Grzejszczak
2016-09-23 10:54:06 +02:00
parent 2a5f6af15e
commit 6991dc6dc3
1 changed files with 20 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
spring-cloud-contract.html
View File

@@ -463,7 +463,16 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<li><a href="#_api_versioning">API Versioning</a></li>
<li><a href="#_jar_versioning">JAR versioning</a></li>
<li><a href="#_dev_or_prod_stubs">Dev or prod stubs</a></li>
<li><a href="#_common_repo_with_contracts">Common repo with contracts</a></li>
</ul>
</li>
<li><a href="#_common_repo_with_contracts">Common repo with contracts</a>
<ul class="sectlevel4">
<li><a href="#_workflow">Workflow</a>
<ul class="sectlevel5">
<li><a href="#_consumer">Consumer</a></li>
<li><a href="#_producer">Producer</a></li>
</ul>
</li>
</ul>
</li>
</ul>
@@ -2013,8 +2022,9 @@ version. Example for 2.1.1.</p>
<p>You can pass those values also via properties from your deployment pipeline.</p>
</div>
</div>
<div class="sect4">
<h5 id="_common_repo_with_contracts">Common repo with contracts</h5>
</div>
<div class="sect3">
<h4 id="_common_repo_with_contracts">Common repo with contracts</h4>
<div class="paragraph">
<p>Another way of storing contracts other than having them with the producer is keeping them in a common place.
It can be related to security issues where the consumers can&#8217;t clone the producer&#8217;s code. Also if you keep
@@ -2256,17 +2266,15 @@ Those poms are necessary for the consumer side to run <code>mvn clean install -D
&lt;/assembly&gt;</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Workflow</strong></p>
</div>
<div class="sect4">
<h5 id="_workflow">Workflow</h5>
<div class="paragraph">
<p>The workflow would look similar to the one presented in the <code>Step by step guide to CDC</code>. The only difference
is that the producer doesn&#8217;t own the contracts anymore. So the consumer and the producer have to work on
common contracts in a common repository.</p>
</div>
<div class="paragraph">
<p><em>Consumer</em></p>
</div>
<div class="sect5">
<h6 id="_consumer">Consumer</h6>
<div class="paragraph">
<p>When the <strong>consumer</strong> wants to work on the contracts offline, instead of cloning the producer code, the
consumer team clones the common repository, goes to the required producer&#8217;s folder (e.g. <code>com/example/server</code>)
@@ -2284,9 +2292,9 @@ You need to have <a href="http://maven.apache.org/download.cgi">Maven installed
</tr>
</table>
</div>
<div class="paragraph">
<p><em>Producer</em></p>
</div>
<div class="sect5">
<h6 id="_producer">Producer</h6>
<div class="paragraph">
<p>As a <strong>producer</strong> it&#8217;s enough to alter the Spring Cloud Contract Verifier to provide the URL and the dependency
of the JAR containing the contracts:</p>
@@ -2319,6 +2327,7 @@ when some incompatible changes are done.</p>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_spring_cloud_contract_verifier_http">Spring Cloud Contract Verifier HTTP</h3>
<div class="sect3">