org.cornutum.tcases.openapi

Class TcasesOpenApi

java.lang.Object

org.cornutum.tcases.openapi.TcasesOpenApi

public final class TcasesOpenApi
extends Object

Defines methods for converting between OpenAPI models and Tcases models.

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

Method Summary

Modifier and Type	Method and Description
static SystemInputDef	getRequestInputModel(io.swagger.v3.oas.models.OpenAPI api) Returns a system input definition for the API requests defined by the given OpenAPI specification.
static SystemInputDef	getRequestInputModel(io.swagger.v3.oas.models.OpenAPI api, ModelOptions options) Returns a system input definition for the API requests defined by the given OpenAPI specification.
static SystemInputDef	getResponseInputModel(io.swagger.v3.oas.models.OpenAPI api) Returns a system input definition for the API responses defined by the given OpenAPI specification.
static SystemInputDef	getResponseInputModel(io.swagger.v3.oas.models.OpenAPI api, ModelOptions options) Returns a system input definition for the API responses defined by the given OpenAPI specification.

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(io.swagger.v3.oas.models.OpenAPI 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(io.swagger.v3.oas.models.OpenAPI 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.

getResponseInputModel

public static SystemInputDef getResponseInputModel(io.swagger.v3.oas.models.OpenAPI 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(io.swagger.v3.oas.models.OpenAPI 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.