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

Updated the docs with proper links; fixes gh-672

Browse Source
This commit is contained in:
Marcin Grzejszczak
2018-07-02 14:19:10 +02:00
parent a4f9b600fb
commit adcdf30be5
8 changed files with 11 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.adoc
View File

@@ -1035,8 +1035,7 @@ of an identifier or a timestamp, you need not hardcode a value. You want to allo
different ranges of values. To enable ranges of values, you can set regular expressions
matching those values for the consumer side. You can provide the body by means of either
a map notation or String with interpolations.
https://cloud.spring.io/spring-cloud-contract/single/spring-cloud-contract.html#_contract_dsl[Consult the docs
for more information.] We highly recommend using the map notation!
Consult the <<contract_dsl>> section for more information. We highly recommend using the map notation!
TIP: You must understand the map notation in order to set up contracts. Please read the
http://groovy-lang.org/json.html[Groovy docs regarding JSON].
@@ -1447,23 +1446,13 @@ https://github.com/spring-cloud-samples/spring-cloud-contract-samples[samples].
== Links
The following links may be helpful when working with Spring Cloud Contract Verifier:
The following links may be helpful when working with Spring Cloud Contract:
* https://github.com/spring-cloud/spring-cloud-contract/[Spring Cloud Contract Github
Repository]
* https://github.com/spring-cloud-samples/spring-cloud-contract-samples/[Spring Cloud
Contract Samples]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html[Spring Cloud
Contract Documentation]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/deprecated[Accurest
Legacy Documentation]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#spring-cloud-contract-stub-runner[Spring
Cloud Contract Stub Runner Documentation]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#stub-runner-for-messaging[Spring
Cloud Contract Stub Runner Messaging Documentation]
* https://gitter.im/spring-cloud/spring-cloud-contract[Spring Cloud Contract Gitter]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-maven-plugin/[Spring
Cloud Contract Maven Plugin]
* https://www.youtube.com/watch?v=sAAklvxmPmk[Spring Cloud Contract WJUG Presentation by
Marcin Grzejszczak]
@@ -1857,8 +1846,7 @@ methods to create request matchers, but you can't use both approaches.
On the consumer side, you can make the `resource.json` generated earlier in this section
available on the classpath (by
https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html#_publishing_stubs_as_jars[publishing
stubs as JARs], for example). After that, you can create a stub using WireMock in a
<<publishing-stubs-as-jars], for example). After that, you can create a stub using WireMock in a
number of different ways, including by using
`@AutoConfigureWireMock(stubs="classpath:resource.json")`, as described earlier in this
document.

12
docs/src/main/asciidoc/links.adoc
View File

@@ -1,21 +1,11 @@
== Links
The following links may be helpful when working with Spring Cloud Contract Verifier:
The following links may be helpful when working with Spring Cloud Contract:
* https://github.com/spring-cloud/spring-cloud-contract/[Spring Cloud Contract Github
Repository]
* https://github.com/spring-cloud-samples/spring-cloud-contract-samples/[Spring Cloud
Contract Samples]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html[Spring Cloud
Contract Documentation]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/deprecated[Accurest
Legacy Documentation]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#spring-cloud-contract-stub-runner[Spring
Cloud Contract Stub Runner Documentation]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#stub-runner-for-messaging[Spring
Cloud Contract Stub Runner Messaging Documentation]
* https://gitter.im/spring-cloud/spring-cloud-contract[Spring Cloud Contract Gitter]
* https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-maven-plugin/[Spring
Cloud Contract Maven Plugin]
* https://www.youtube.com/watch?v=sAAklvxmPmk[Spring Cloud Contract WJUG Presentation by
Marcin Grzejszczak]

3
docs/src/main/asciidoc/spring-cloud-wiremock.adoc
View File

@@ -324,8 +324,7 @@ methods to create request matchers, but you can't use both approaches.
On the consumer side, you can make the `resource.json` generated earlier in this section
available on the classpath (by
https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html#_publishing_stubs_as_jars[publishing
stubs as JARs], for example). After that, you can create a stub using WireMock in a
<<publishing-stubs-as-jars], for example). After that, you can create a stub using WireMock in a
number of different ways, including by using
`@AutoConfigureWireMock(stubs="classpath:resource.json")`, as described earlier in this
document.

2
docs/src/main/asciidoc/verifier_faq.adoc
View File

@@ -127,7 +127,7 @@ $(stub(...), test(...))
$(client(...), server(...))
----
You can read more about this in the https://cloud.spring.io/spring-cloud-contract/single/spring-cloud-contract.html#_contract_dsl[Contract DSL section].
You can read more about this in the <<contract-dsl>> section.
Calling `value()` or `$()` tells Spring Cloud Contract that you will be passing a dynamic value.
Inside the `consumer()` method you pass the value that should be used on the consumer side (in the generated stub).

3
docs/src/main/asciidoc/verifier_introduction.adoc
View File

@@ -698,8 +698,7 @@ of an identifier or a timestamp, you need not hardcode a value. You want to allo
different ranges of values. To enable ranges of values, you can set regular expressions
matching those values for the consumer side. You can provide the body by means of either
a map notation or String with interpolations.
https://cloud.spring.io/spring-cloud-contract/single/spring-cloud-contract.html#_contract_dsl[Consult the docs
for more information.] We highly recommend using the map notation!
Consult the <<contract_dsl>> section for more information. We highly recommend using the map notation!
TIP: You must understand the map notation in order to set up contracts. Please read the
http://groovy-lang.org/json.html[Groovy docs regarding JSON].

4
docs/src/main/asciidoc/verifier_messaging.adoc
View File

@@ -180,9 +180,7 @@ include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract
Unlike the HTTP part, in messaging, we need to publish the Groovy DSL inside the JAR with
a stub. Then it is parsed on the consumer side and proper stubbed routes are created.
For more information, see
https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#stub-runner-for-messaging[the
Stub Runner Messaging sections].
For more information, see <<stub-runner-for-messaging>> section.
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven

4
docs/src/main/asciidoc/verifier_setup.adoc
View File

@@ -438,8 +438,8 @@ include::{standalone_samples_path}/http-server/pom.xml[tags=contract_maven_plugi
----
You can read more in the
https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-maven-plugin/[Spring
Cloud Contract Maven Plugin Documentation].
https://cloud.spring.io/spring-cloud-static/spring-cloud-contract/2.0.0.RELEASE/spring-cloud-contract-maven-plugin/[Spring
Cloud Contract Maven Plugin Documentation (example for `2.0.0.RELEASE` version)].
[[maven-rest-assured]]
==== Maven and Rest Assured 2.0

1
docs/src/main/asciidoc/verifier_stubrunner.adoc
View File

@@ -25,6 +25,7 @@ include::{standalone_samples_path}/http-server/pom.xml[tags=repos,indent=0]
include::{standalone_samples_path}/http-server/build.gradle[tags=repos,indent=0]
----
[[publishing-stubs-as-jars]]
=== Publishing Stubs as JARs
The easiest approach would be to centralize the way stubs are kept. For example, you can