This section provides a brief overview of Spring Cloud Contract reference documentation. It serves as a map for the rest of the document.
The Spring Cloud Contract reference guide is available as
Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
If you have trouble with Spring Cloud Contract, we would like to help.
Try the How-to documents. They provide solutions to the most common questions.
Learn the Spring Cloud Contract basics. If you are starting out with Spring Cloud Contract, try one of the guides.
Report bugs with Spring Cloud Contract at github.com/spring-cloud/spring-cloud-contract/issues.
Chat with us at Spring Cloud Contract Gitter
|All of Spring Cloud Contract is open source, including the documentation. If you find problems with the docs or if you want to improve them, please get involved.|
Ready to actually start using Spring Cloud Contract? We have you covered:
Provider contract testing:
Consumer-Driven contract testing:
|We talk about Provider Contracts when it is the producer of the API that defines the contracts and publishes it for all its consumers to use. This approach is useful for producers that cannot directly collaborate with their consumers — for example, when there are too many consumers or the consumers are external (do not work within the same company).|
|We use the term, Consumer-Driven Contracts, to refer to workflows where the consumers of an API play a vital role in the process of creating the contracts. We recommended this approach, because it is easy to implement when both producer and consumer teams work for the same organizations and the number of consumers is not extremely large.|
Need more details about Spring Cloud Contract’s core features? The following content is for you:
Finally, we have a few topics for more advanced users: