Spring Cloud Contract Maven Plugin – Plugin Documentation

Plugin Documentation

Goals available for this plugin:

Goal	Description
spring-cloud-contract:convert	Convert Spring Cloud Contract Verifier contracts into stubs mappings. This goal allows you to generate `stubs-jar` or execute `spring-cloud-contract:run` with generated mappings.
spring-cloud-contract:generateStubs	Picks the converted .json files and creates a jar. Requires convert to be executed first.
spring-cloud-contract:generateTests	From the provided directory with contracts generates the acceptance tests on the producer side.
spring-cloud-contract:help	Display help information on spring-cloud-contract-maven-plugin. Call `mvn spring-cloud-contract:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
spring-cloud-contract:pushStubsToScm	The generated stubs get committed to the SCM repo and pushed to origin.
spring-cloud-contract:run	Mojo for running stubs.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.6
JDK	17
Memory	No minimum requirement.
Disk Space	No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-contract-maven-plugin</artifactId>
          <version>4.0.6</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-contract-maven-plugin</artifactId>
        <version>4.0.6</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"