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:
buildmaster
2016-09-26 12:43:32 +00:00
parent f833f9bd78
commit 7bb2a69917
1 changed files with 43 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
spring-cloud-contract.html
View File

@@ -659,6 +659,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<li><a href="#_contract_dsl">Contract DSL</a>
<ul class="sectlevel3">
<li><a href="#_limitations">Limitations</a></li>
<li><a href="#_common_top_level_elements">Common Top-Level elements</a>
<ul class="sectlevel4">
<li><a href="#_description">Description</a></li>
<li><a href="#_ignoring_contracts">Ignoring contracts</a></li>
</ul>
</li>
<li><a href="#_http_top_level_elements">HTTP Top-Level Elements</a></li>
<li><a href="#_request">Request</a></li>
<li><a href="#_response">Response</a></li>
@@ -5328,6 +5334,43 @@ Groovy Map notation.
</div>
</div>
<div class="sect3">
<h4 id="_common_top_level_elements">Common Top-Level elements</h4>
<div class="sect4">
<h5 id="_description">Description</h5>
<div class="paragraph">
<p>You can add a <code>description</code> to your contract that is nothing else but an arbitrary text. Example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-groovy" data-lang="groovy"> org.springframework.cloud.contract.spec.Contract.make {
description('''
given:
An input
when:
Sth happens
then:
Output
''')
}</code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="_ignoring_contracts">Ignoring contracts</h5>
<div class="paragraph">
<p>If you want to ignore a contract you can either set a value of ignored contracts in the plugin configuration
or just set the <code>ignored</code> property on the contract itself:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-groovy" data-lang="groovy">org.springframework.cloud.contract.spec.Contract.make {
ignored()
}</code></pre>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_http_top_level_elements">HTTP Top-Level Elements</h4>
<div class="paragraph">
<p>Following methods can be called in the top-level closure of a contract definition. Request and response are mandatory, priority is optional.</p>