org.mockserver.mock

Class OpenAPIExpectation

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.mock.OpenAPIExpectation

public class OpenAPIExpectation
extends ObjectWithJsonToString

Author:

jamesdbloom

Constructor Summary

Constructors

Constructor and Description
OpenAPIExpectation()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<String,String>	getOperationsAndResponses()
String	getSpecUrlOrPayload()
int	hashCode()
static OpenAPIExpectation	openAPIExpectation()
static OpenAPIExpectation	openAPIExpectation(String specUrlOrPayload) Specify the OpenAPI to create matchers and example responses for:
static OpenAPIExpectation	openAPIExpectation(String specUrlOrPayload, Map<String,String> operationsAndResponses) Specify the OpenAPI and operations and responses to create matchers and example responses for:
OpenAPIExpectation	withOperationsAndResponses(Map<String,String> operationsAndResponses) The operations and responses to use for each example response where the key is the operationId in the OpenAPI and the value if the response key (i.e.
OpenAPIExpectation	withSpecUrlOrPayload(String specUrlOrPayload) Specify the OpenAPI specification:

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenAPIExpectation

public OpenAPIExpectation()

Method Detail

openAPIExpectation

public static OpenAPIExpectation openAPIExpectation()

openAPIExpectation

public static OpenAPIExpectation openAPIExpectation(String specUrlOrPayload,
                                                    Map<String,String> operationsAndResponses)

Specify the OpenAPI and operations and responses to create matchers and example responses for:

 // Create from a publicly hosted HTTP location (json or yaml)
 openAPIExpectation("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));

 // Create from a file on the local filesystem (json or yaml)
 openAPIExpectation("file://Users/myuser/git/mockserver/mockserver-core/src/test/resources/org/mockserver/openapi/openapi_petstore_example.json", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));

 // Create from a classpath resource in the /api package (json or yaml)
 openAPIExpectation("org/mockserver/openapi/openapi_petstore_example.json", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));

 // Create from an OpenAPI payload (json or yaml)
 openAPIExpectation("{\"openapi\": \"3.0.0\", \"info\": { ...", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));
 

Parameters:

specUrlOrPayload - the OpenAPI to match against by URL or payload

operationsAndResponses - operations and responses to use for each example response where the key is the operationId in the OpenAPI and the value if the response key (i.e. "200", "400" or "default")

Returns:

the OpenAPIExpectation

openAPIExpectation

public static OpenAPIExpectation openAPIExpectation(String specUrlOrPayload)

Specify the OpenAPI to create matchers and example responses for:

 // Create from a publicly hosted HTTP location (json or yaml)
 openAPIExpectation("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));

 // Create from a file on the local filesystem (json or yaml)
 openAPIExpectation("file://Users/myuser/git/mockserver/mockserver-core/src/test/resources/org/mockserver/openapi/openapi_petstore_example.json", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));

 // Create from a classpath resource in the /api package (json or yaml)
 openAPIExpectation("org/mockserver/openapi/openapi_petstore_example.json", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));

 // Create from an OpenAPI payload (json or yaml)
 openAPIExpectation("{\"openapi\": \"3.0.0\", \"info\": { ...", ImmutableMap.of(
     "listPets", "500",
     "createPets", "default",
     "showPetById", "200"
 ));
 

Parameters:

specUrlOrPayload - the OpenAPI to match against by URL or payload

Returns:

the OpenAPIExpectation

getSpecUrlOrPayload

public String getSpecUrlOrPayload()

withSpecUrlOrPayload

public OpenAPIExpectation withSpecUrlOrPayload(String specUrlOrPayload)

Specify the OpenAPI specification:

 // Create from a publicly hosted HTTP location (json or yaml)
 withSpecUrlOrPayload("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml");

 // Create from a file on the local filesystem (json or yaml)
 withSpecUrlOrPayload("file://Users/myuser/git/mockserver/mockserver-core/src/test/resources/org/mockserver/openapi/openapi_petstore_example.json");

 // Create from a classpath resource in the /api package (json or yaml)
 withSpecUrlOrPayload("org/mockserver/openapi/openapi_petstore_example.json");

 // Create from an OpenAPI payload (json or yaml)
 withSpecUrlOrPayload("{\"openapi\": \"3.0.0\", \"info\": { ...");
 

Parameters:

specUrlOrPayload - the OpenAPI to match against by URL or payload

Returns:

this OpenAPIExpectation

getOperationsAndResponses

public Map<String,String> getOperationsAndResponses()

withOperationsAndResponses

public OpenAPIExpectation withOperationsAndResponses(Map<String,String> operationsAndResponses)

The operations and responses to use for each example response where the key is the operationId in the OpenAPI and the value if the response key (i.e. "200", "400" or "default")

Parameters:

operationsAndResponses - operations and responses to use for each example response

Returns:

this OpenAPIExpectation

equals

public boolean equals(Object o)

Overrides:

equals in class ObjectWithReflectiveEqualsHashCodeToString

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectWithReflectiveEqualsHashCodeToString