public final class OpenApiUtils extends Object
Modifier and Type | Method and Description |
---|---|
static io.swagger.v3.oas.models.examples.Example |
componentExampleRef(io.swagger.v3.oas.models.OpenAPI api,
String reference)
When the given reference is non-null, returns the component example referenced.
|
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 Object |
exampleValue(io.swagger.v3.oas.models.examples.Example example)
Returns the value of the given example.
|
static <T> T |
expectedValueOf(T value,
String description,
Object... descriptionArgs)
Returns the given value if non-null.
|
static Characters |
getParamCharacters(String location,
String style)
Returns the characters allowed in values for a parameter with the given properties.
|
static io.swagger.v3.oas.models.security.SecurityScheme |
getSecurityScheme(io.swagger.v3.oas.models.OpenAPI api,
String scheme)
Returns the given security scheme
|
static io.swagger.v3.oas.models.parameters.Parameter.StyleEnum |
ifApplicableStyle(io.swagger.v3.oas.models.parameters.Parameter.StyleEnum style,
String in,
String type)
Returns the given parameter "style" property if it is applicable for the given
parameter "in" and "type" properties.
|
static String |
ifApplicableStyle(String style,
String in,
String type)
Returns the given parameter "style" property if it is applicable for the given
parameter "in" and "type" properties.
|
static io.swagger.v3.oas.models.examples.Example |
resolveExample(io.swagger.v3.oas.models.OpenAPI api,
io.swagger.v3.oas.models.examples.Example example)
If the given example is defined by a reference, returns the referenced example.
|
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.
|
static ResponsesDef |
responsesDef(io.swagger.v3.oas.models.OpenAPI api)
Returns the responses definition defined for the given API.
|
public static <T> T expectedValueOf(T value, String description, Object... descriptionArgs)
public static Characters getParamCharacters(String location, String style)
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)
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)
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)
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)
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)
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)
public static io.swagger.v3.oas.models.examples.Example resolveExample(io.swagger.v3.oas.models.OpenAPI api, io.swagger.v3.oas.models.examples.Example example)
public static Object exampleValue(io.swagger.v3.oas.models.examples.Example example)
public static io.swagger.v3.oas.models.parameters.Parameter componentParameterRef(io.swagger.v3.oas.models.OpenAPI api, String reference)
public static io.swagger.v3.oas.models.media.Schema componentSchemaRef(io.swagger.v3.oas.models.OpenAPI api, String reference)
public static io.swagger.v3.oas.models.parameters.RequestBody componentRequestBodyRef(io.swagger.v3.oas.models.OpenAPI api, String reference)
public static io.swagger.v3.oas.models.responses.ApiResponse componentResponseRef(io.swagger.v3.oas.models.OpenAPI api, String reference)
public static io.swagger.v3.oas.models.headers.Header componentHeaderRef(io.swagger.v3.oas.models.OpenAPI api, String reference)
public static io.swagger.v3.oas.models.examples.Example componentExampleRef(io.swagger.v3.oas.models.OpenAPI api, String reference)
public static String componentName(String refType, String ref)
public static io.swagger.v3.oas.models.security.SecurityScheme getSecurityScheme(io.swagger.v3.oas.models.OpenAPI api, String scheme)
public static String ifApplicableStyle(String style, String in, String type) throws InvalidStyleException
InvalidStyleException
.InvalidStyleException
public static io.swagger.v3.oas.models.parameters.Parameter.StyleEnum ifApplicableStyle(io.swagger.v3.oas.models.parameters.Parameter.StyleEnum style, String in, String type) throws InvalidStyleException
InvalidStyleException
.InvalidStyleException
public static ResponsesDef responsesDef(io.swagger.v3.oas.models.OpenAPI api)
Copyright © 2024 The Cornutum Project. All rights reserved.