org.cornutum.tcases.openapi

Class OpenApiUtils

java.lang.Object

org.cornutum.tcases.openapi.OpenApiUtils

public final class OpenApiUtils
extends Object

Defines methods for accessing an OpenAPI specification.

Method Summary

Modifier and Type	Method and Description
static io.swagger.v3.oas.models.headers.Header	componentHeaderRef(io.swagger.v3.oas.models.OpenAPI api, String reference) When the given reference is non-null, returns the component header referenced.
static String	componentName(String refType, String ref) Returns the name of the given component reference.
static io.swagger.v3.oas.models.parameters.Parameter	componentParameterRef(io.swagger.v3.oas.models.OpenAPI api, String reference) When the given reference is non-null, returns the component parameter referenced.
static io.swagger.v3.oas.models.parameters.RequestBody	componentRequestBodyRef(io.swagger.v3.oas.models.OpenAPI api, String reference) When the given reference is non-null, returns the component request body referenced.
static io.swagger.v3.oas.models.responses.ApiResponse	componentResponseRef(io.swagger.v3.oas.models.OpenAPI api, String reference) When the given reference is non-null, returns the component response referenced.
static io.swagger.v3.oas.models.media.Schema	componentSchemaRef(io.swagger.v3.oas.models.OpenAPI api, String reference) When the given reference is non-null, returns the component schema referenced.
static <T> T	expectedValueOf(T value, String description, Object... descriptionArgs) Returns the given value if non-null.
static io.swagger.v3.oas.models.headers.Header	resolveHeader(io.swagger.v3.oas.models.OpenAPI api, io.swagger.v3.oas.models.headers.Header header) If the given header is defined by a reference, returns the referenced header.
static io.swagger.v3.oas.models.parameters.Parameter	resolveParameter(io.swagger.v3.oas.models.OpenAPI api, io.swagger.v3.oas.models.parameters.Parameter parameter) If the given parameter is defined by a reference, returns the referenced parameter.
static io.swagger.v3.oas.models.parameters.RequestBody	resolveRequestBody(io.swagger.v3.oas.models.OpenAPI api, io.swagger.v3.oas.models.parameters.RequestBody requestBody) If the given request body is defined by a reference, returns the referenced requestBody.
static io.swagger.v3.oas.models.responses.ApiResponse	resolveResponse(io.swagger.v3.oas.models.OpenAPI api, io.swagger.v3.oas.models.responses.ApiResponse response) If the given response is defined by a reference, returns the referenced response.
static io.swagger.v3.oas.models.media.Schema<?>	resolveSchema(io.swagger.v3.oas.models.OpenAPI api, io.swagger.v3.oas.models.media.Schema<?> schema) If the given schema is defined by a reference, returns the referenced schema.
static io.swagger.v3.oas.models.media.ComposedSchema	resolveSchemaMembers(io.swagger.v3.oas.models.OpenAPI api, io.swagger.v3.oas.models.media.ComposedSchema composed) Returns the given schema after resolving schemas referenced by any "allOf", "anyOf", or "oneOf" members.

Methods inherited from class java.lang.Object

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

Method Detail

expectedValueOf

public static <T> T expectedValueOf(T value,
                                    String description,
                                    Object... descriptionArgs)

Returns the given value if non-null. Otherwise, throws an exception.

resolveParameter

public static io.swagger.v3.oas.models.parameters.Parameter resolveParameter(io.swagger.v3.oas.models.OpenAPI api,
                                                                             io.swagger.v3.oas.models.parameters.Parameter parameter)

If the given parameter is defined by a reference, returns the referenced parameter. Otherwise, returns the given parameter.

resolveSchema

public static io.swagger.v3.oas.models.media.Schema<?> resolveSchema(io.swagger.v3.oas.models.OpenAPI api,
                                                                     io.swagger.v3.oas.models.media.Schema<?> schema)

If the given schema is defined by a reference, returns the referenced schema. Otherwise, returns the given schema.

resolveSchemaMembers

public static io.swagger.v3.oas.models.media.ComposedSchema resolveSchemaMembers(io.swagger.v3.oas.models.OpenAPI api,
                                                                                 io.swagger.v3.oas.models.media.ComposedSchema composed)

Returns the given schema after resolving schemas referenced by any "allOf", "anyOf", or "oneOf" members.

resolveRequestBody

public static io.swagger.v3.oas.models.parameters.RequestBody resolveRequestBody(io.swagger.v3.oas.models.OpenAPI api,
                                                                                 io.swagger.v3.oas.models.parameters.RequestBody requestBody)

If the given request body is defined by a reference, returns the referenced requestBody. Otherwise, returns the given request body.

resolveResponse

public static io.swagger.v3.oas.models.responses.ApiResponse resolveResponse(io.swagger.v3.oas.models.OpenAPI api,
                                                                             io.swagger.v3.oas.models.responses.ApiResponse response)

If the given response is defined by a reference, returns the referenced response. Otherwise, returns the given response.

resolveHeader

public static io.swagger.v3.oas.models.headers.Header resolveHeader(io.swagger.v3.oas.models.OpenAPI api,
                                                                    io.swagger.v3.oas.models.headers.Header header)

If the given header is defined by a reference, returns the referenced header. Otherwise, returns the given header.

componentParameterRef

public static io.swagger.v3.oas.models.parameters.Parameter componentParameterRef(io.swagger.v3.oas.models.OpenAPI api,
                                                                                  String reference)

When the given reference is non-null, returns the component parameter referenced.

componentSchemaRef

public static io.swagger.v3.oas.models.media.Schema componentSchemaRef(io.swagger.v3.oas.models.OpenAPI api,
                                                                       String reference)

When the given reference is non-null, returns the component schema referenced.

componentRequestBodyRef

public static io.swagger.v3.oas.models.parameters.RequestBody componentRequestBodyRef(io.swagger.v3.oas.models.OpenAPI api,
                                                                                      String reference)

When the given reference is non-null, returns the component request body referenced.

componentResponseRef

public static io.swagger.v3.oas.models.responses.ApiResponse componentResponseRef(io.swagger.v3.oas.models.OpenAPI api,
                                                                                  String reference)

When the given reference is non-null, returns the component response referenced.

componentHeaderRef

public static io.swagger.v3.oas.models.headers.Header componentHeaderRef(io.swagger.v3.oas.models.OpenAPI api,
                                                                         String reference)

When the given reference is non-null, returns the component header referenced.

componentName

public static String componentName(String refType,
                                   String ref)

Returns the name of the given component reference.