org.springframework.cloud.contract.verifier.converter

Interface StubGenerator

All Known Implementing Classes:

DslToWireMockClientConverter, DslToWireMockConverter

public interface StubGenerator

Converts contracts into their stub representation.

Since:

1.1.0

Method Summary

Modifier and Type	Method and Description
default boolean	canHandleFileName(String fileName)
Map<org.springframework.cloud.contract.spec.Contract,String>	convertContents(String rootName, org.springframework.cloud.contract.verifier.file.ContractMetadata content)
default String	fileExtension() Describes the file extension that this stub generator can handle.
String	generateOutputFileNameForInput(String inputFileName)

Method Detail

canHandleFileName

default boolean canHandleFileName(String fileName)

Parameters:

fileName - - file name

Returns:

true if the converter can handle the file to convert it into a stub.

convertContents

Map<org.springframework.cloud.contract.spec.Contract,String> convertContents(String rootName,
                                                                             org.springframework.cloud.contract.verifier.file.ContractMetadata content)

Parameters:

rootName - - root name of the contract

content - - metadata of the contract

Returns:

the collection of converted contracts into stubs. One contract can result in multiple stubs.

generateOutputFileNameForInput

String generateOutputFileNameForInput(String inputFileName)

Parameters:

inputFileName - - name of the input file

Returns:

the name of the converted stub file. If you have multiple contracts in a single file then a prefix will be added to the generated file. If you provide the Contract.name field then that field will override the generated file name. Example: name of file with 2 contracts is foo.groovy, it will be converted by the implementation to foo.json. The recursive file converter will create two files 0_foo.json and 1_foo.json

fileExtension

default String fileExtension()

Describes the file extension that this stub generator can handle.

Returns:

string describing the file extension