org.cornutum.tcases.openapi.io

Class TcasesOpenApiIO

java.lang.Object

org.cornutum.tcases.openapi.io.TcasesOpenApiIO

public final class TcasesOpenApiIO
extends Object

Defines methods for generating Tcases documents from OpenAPI documents.

OpenAPI documents must conform to OAS version 3. See https://swagger.io/specification/#specification.

Method Summary

Modifier and Type	Method and Description
static SystemInputDef	getRequestInputModel(File api) Returns a system input definition for the API requests defined by the given OpenAPI specification.
static SystemInputDef	getRequestInputModel(File api, ModelOptions options) Returns a system input definition for the API requests defined by the given OpenAPI specification.
static SystemInputDef	getRequestInputModel(File api, String defaultDocType, ModelOptions options) Returns a system input definition for the API requests defined by the given OpenAPI specification.
static SystemInputDef	getRequestInputModel(InputStream api) Returns a system input definition for the API requests defined by the OpenAPI specification in the given JSON document.
static SystemInputDef	getRequestInputModel(InputStream api, ModelOptions options) Returns a system input definition for the API requests defined by the OpenAPI specification in the given JSON document.
static SystemInputDef	getRequestInputModel(InputStream api, String docType, ModelOptions options) Returns a system input definition for the API requests defined by the given OpenAPI specification document.
static SystemTestDef	getRequestTests(File api) Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getRequestTests(File api, ModelOptions options) Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getRequestTests(File api, String defaultDocType, ModelOptions options) Returns a system test definition for the API requests defined by the given OpenAPI specification.
static SystemTestDef	getRequestTests(InputStream api) Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getRequestTests(InputStream api, ModelOptions options) Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getRequestTests(InputStream api, String docType, ModelOptions options) Returns a system test definition for the API requests defined by the given OpenAPI specification.
static SystemInputDef	getResponseInputModel(File api) Returns a system input definition for the API responses defined by the given OpenAPI specification.
static SystemInputDef	getResponseInputModel(File api, ModelOptions options) Returns a system input definition for the API responses defined by the given OpenAPI specification.
static SystemInputDef	getResponseInputModel(File api, String defaultDocType, ModelOptions options) Returns a system input definition for the API responses defined by the given OpenAPI specification.
static SystemInputDef	getResponseInputModel(InputStream api) Returns a system input definition for the API responses defined by the OpenAPI specification in the given JSON document.
static SystemInputDef	getResponseInputModel(InputStream api, ModelOptions options) Returns a system input definition for the API responses defined by the OpenAPI specification in the given JSON document.
static SystemInputDef	getResponseInputModel(InputStream api, String docType, ModelOptions options) Returns a system input definition for the API responses defined by the given OpenAPI specification document.
static SystemTestDef	getResponseTests(File api) Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getResponseTests(File api, ModelOptions options) Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getResponseTests(File api, String defaultDocType, ModelOptions options) Returns a system test definition for the API responses defined by the given OpenAPI specification.
static SystemTestDef	getResponseTests(InputStream api) Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getResponseTests(InputStream api, ModelOptions options) Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document.
static SystemTestDef	getResponseTests(InputStream api, String docType, ModelOptions options) Returns a system test definition for the API responses defined by the given OpenAPI specification.
static void	writeInputModel(SystemInputDef inputDef, OutputStream outputStream) Writes a JSON document describing the given system input definition to the given output stream.
static void	writeRequestCases(RequestTestDef requestTestDef, OutputStream outputStream) Writes a JSON document listing the given request test cases to the given output stream.
static void	writeRequestCases(SystemTestDef testDef, ResolverContext context, OutputStream outputStream) Writes a JSON document listing test cases defined by the given request test case definitions to the given output stream.
static void	writeTests(SystemTestDef testDef, OutputStream outputStream) Writes a JSON document describing the given test case definitions to the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRequestInputModel

public static SystemInputDef getRequestInputModel(InputStream api)

Returns a system input definition for the API requests defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API requests to model.

getRequestInputModel

public static SystemInputDef getRequestInputModel(InputStream api,
                                                  ModelOptions options)

Returns a system input definition for the API requests defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API requests to model.

getRequestInputModel

public static SystemInputDef getRequestInputModel(InputStream api,
                                                  String docType,
                                                  ModelOptions options)

Returns a system input definition for the API requests defined by the given OpenAPI specification document. Returns null if the given spec defines no API requests to model.

getRequestInputModel

public static SystemInputDef getRequestInputModel(File api)

Returns a system input definition for the API requests defined by the given OpenAPI specification. Returns null if the given spec defines no API requests to model.

getRequestInputModel

public static SystemInputDef getRequestInputModel(File api,
                                                  ModelOptions options)

Returns a system input definition for the API requests defined by the given OpenAPI specification. Returns null if the given spec defines no API requests to model.

getRequestInputModel

public static SystemInputDef getRequestInputModel(File api,
                                                  String defaultDocType,
                                                  ModelOptions options)

Returns a system input definition for the API requests defined by the given OpenAPI specification. Returns null if the given spec defines no API requests to model.

getRequestTests

public static SystemTestDef getRequestTests(InputStream api)

Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API requests to model.

getRequestTests

public static SystemTestDef getRequestTests(InputStream api,
                                            ModelOptions options)

Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API requests to model.

getRequestTests

public static SystemTestDef getRequestTests(InputStream api,
                                            String docType,
                                            ModelOptions options)

Returns a system test definition for the API requests defined by the given OpenAPI specification. Returns null if the given spec defines no API requests to model.

getRequestTests

public static SystemTestDef getRequestTests(File api)

Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API requests to model.

getRequestTests

public static SystemTestDef getRequestTests(File api,
                                            ModelOptions options)

Returns a system test definition for the API requests defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API requests to model.

getRequestTests

public static SystemTestDef getRequestTests(File api,
                                            String defaultDocType,
                                            ModelOptions options)

Returns a system test definition for the API requests defined by the given OpenAPI specification. Returns null if the given spec defines no API requests to model.

getResponseInputModel

public static SystemInputDef getResponseInputModel(InputStream api)

Returns a system input definition for the API responses defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API responses to model.

getResponseInputModel

public static SystemInputDef getResponseInputModel(InputStream api,
                                                   ModelOptions options)

Returns a system input definition for the API responses defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API responses to model.

getResponseInputModel

public static SystemInputDef getResponseInputModel(InputStream api,
                                                   String docType,
                                                   ModelOptions options)

Returns a system input definition for the API responses defined by the given OpenAPI specification document. Returns null if the given spec defines no API responses to model.

getResponseInputModel

public static SystemInputDef getResponseInputModel(File api)

Returns a system input definition for the API responses defined by the given OpenAPI specification. Returns null if the given spec defines no API responses to model.

getResponseInputModel

public static SystemInputDef getResponseInputModel(File api,
                                                   ModelOptions options)

Returns a system input definition for the API responses defined by the given OpenAPI specification. Returns null if the given spec defines no API responses to model.

getResponseInputModel

public static SystemInputDef getResponseInputModel(File api,
                                                   String defaultDocType,
                                                   ModelOptions options)

Returns a system input definition for the API responses defined by the given OpenAPI specification. Returns null if the given spec defines no API responses to model.

getResponseTests

public static SystemTestDef getResponseTests(InputStream api)

Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API responses to model.

getResponseTests

public static SystemTestDef getResponseTests(InputStream api,
                                             ModelOptions options)

Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API responses to model.

getResponseTests

public static SystemTestDef getResponseTests(InputStream api,
                                             String docType,
                                             ModelOptions options)

Returns a system test definition for the API responses defined by the given OpenAPI specification. Returns null if the given spec defines no API responses to model.

getResponseTests

public static SystemTestDef getResponseTests(File api)

Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API responses to model.

getResponseTests

public static SystemTestDef getResponseTests(File api,
                                             ModelOptions options)

Returns a system test definition for the API responses defined by the OpenAPI specification in the given JSON document. Returns null if the given spec defines no API responses to model.

getResponseTests

public static SystemTestDef getResponseTests(File api,
                                             String defaultDocType,
                                             ModelOptions options)

Returns a system test definition for the API responses defined by the given OpenAPI specification. Returns null if the given spec defines no API responses to model.

writeInputModel

public static void writeInputModel(SystemInputDef inputDef,
                                   OutputStream outputStream)

Writes a JSON document describing the given system input definition to the given output stream.

writeTests

public static void writeTests(SystemTestDef testDef,
                              OutputStream outputStream)

Writes a JSON document describing the given test case definitions to the given output stream.

writeRequestCases

public static void writeRequestCases(SystemTestDef testDef,
                                     ResolverContext context,
                                     OutputStream outputStream)

Writes a JSON document listing test cases defined by the given request test case definitions to the given output stream.

writeRequestCases

public static void writeRequestCases(RequestTestDef requestTestDef,
                                     OutputStream outputStream)

Writes a JSON document listing the given request test cases to the given output stream.