org.openapitools.codegen.utils

类 ModelUtils

java.lang.Object

org.openapitools.codegen.utils.ModelUtils

public class ModelUtils
extends Object

构造器概要

构造器

构造器和说明
ModelUtils()

方法概要

限定符和类型	方法和说明
static io.swagger.v3.oas.models.media.Schema	getAdditionalProperties(io.swagger.v3.oas.models.media.Schema schema)
static List<String>	getAllUsedSchemas(io.swagger.v3.oas.models.OpenAPI openAPI) Return the list of all schemas in the 'components/schemas' section used in the openAPI specification
static io.swagger.v3.oas.models.responses.ApiResponse	getApiResponse(io.swagger.v3.oas.models.OpenAPI openAPI, String name)
static io.swagger.v3.oas.models.callbacks.Callback	getCallback(io.swagger.v3.oas.models.OpenAPI openAPI, String name)
static io.swagger.v3.oas.models.headers.Header	getHeader(io.swagger.v3.oas.models.OpenAPI openAPI, String name)
static CodegenModel	getModelByName(String name, Map<String,Object> models) Searches for the model by name in the map of models and returns it
static io.swagger.v3.oas.models.parameters.Parameter	getParameter(io.swagger.v3.oas.models.OpenAPI openAPI, String name)
static io.swagger.v3.oas.models.responses.ApiResponse	getReferencedApiResponse(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.responses.ApiResponse apiResponse) If a ApiResponse contains a reference to an other ApiResponse with '$ref', returns the referenced ApiResponse if it is found or the actual ApiResponse in the other cases.
static io.swagger.v3.oas.models.callbacks.Callback	getReferencedCallback(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.callbacks.Callback callback) If a Callback contains a reference to an other Callback with '$ref', returns the referenced Callback if it is found or the actual Callback in the other cases.
static io.swagger.v3.oas.models.headers.Header	getReferencedHeader(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.headers.Header header)
static io.swagger.v3.oas.models.parameters.Parameter	getReferencedParameter(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.parameters.Parameter parameter) If a Parameter contains a reference to an other Parameter with '$ref', returns the referenced Parameter if it is found or the actual Parameter in the other cases.
static io.swagger.v3.oas.models.parameters.RequestBody	getReferencedRequestBody(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.parameters.RequestBody requestBody) If a RequestBody contains a reference to an other RequestBody with '$ref', returns the referenced RequestBody if it is found or the actual RequestBody in the other cases.
static io.swagger.v3.oas.models.media.Schema	getReferencedSchema(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.media.Schema schema) If a Schema contains a reference to another Schema with '$ref', returns the referenced Schema if it is found or the actual Schema in the other cases.
static io.swagger.v3.oas.models.parameters.RequestBody	getRequestBody(io.swagger.v3.oas.models.OpenAPI openAPI, String name)
static io.swagger.v3.oas.models.media.Schema	getSchema(io.swagger.v3.oas.models.OpenAPI openAPI, String name)
static io.swagger.v3.oas.models.media.Schema	getSchemaFromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody requestBody) Return the first defined Schema for a RequestBody
static io.swagger.v3.oas.models.media.Schema	getSchemaFromResponse(io.swagger.v3.oas.models.responses.ApiResponse response) Return the first defined Schema for a ApiResponse
static Map<String,io.swagger.v3.oas.models.media.Schema>	getSchemas(io.swagger.v3.oas.models.OpenAPI openAPI)
static List<String>	getSchemasUsedOnlyInFormParam(io.swagger.v3.oas.models.OpenAPI openAPI) Return the list of schemas in the 'components/schemas' used only in a 'application/x-www-form-urlencoded' or 'multipart/form-data' mime time
static String	getSimpleRef(String ref)
static List<String>	getUnusedSchemas(io.swagger.v3.oas.models.OpenAPI openAPI) Return the list of unused schemas in the 'components/schemas' section of an openAPI specification
static boolean	isArraySchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isBinarySchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isBooleanSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isByteArraySchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isComposedSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isDateSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isDateTimeSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isDoubleSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isEmailSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isFileSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isFloatSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isFreeFormObject(io.swagger.v3.oas.models.media.Schema schema) Check to see if the schema is a free form object
static boolean	isIntegerSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isLongSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isMapSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isModel(io.swagger.v3.oas.models.media.Schema schema) Check to see if the schema is a model with at least one properties
static boolean	isNumberSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isObjectSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isPasswordSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isShortchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isStringSchema(io.swagger.v3.oas.models.media.Schema schema)
static boolean	isUUIDSchema(io.swagger.v3.oas.models.media.Schema schema)
static io.swagger.v3.oas.models.media.Schema	unaliasSchema(Map<String,io.swagger.v3.oas.models.media.Schema> allSchemas, io.swagger.v3.oas.models.media.Schema schema) Get the actual schema from aliases.

从类继承的方法 java.lang.Object

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

构造器详细资料

ModelUtils

public ModelUtils()

方法详细资料

getModelByName

public static CodegenModel getModelByName(String name,
                                          Map<String,Object> models)

Searches for the model by name in the map of models and returns it

参数:

name - Name of the model

models - Map of models

返回:

model

getAllUsedSchemas

public static List<String> getAllUsedSchemas(io.swagger.v3.oas.models.OpenAPI openAPI)

Return the list of all schemas in the 'components/schemas' section used in the openAPI specification

参数:

openAPI - specification

返回:

schemas a list of used schemas

getUnusedSchemas

public static List<String> getUnusedSchemas(io.swagger.v3.oas.models.OpenAPI openAPI)

Return the list of unused schemas in the 'components/schemas' section of an openAPI specification

参数:

openAPI - specification

返回:

schemas a list of unused schemas

getSchemasUsedOnlyInFormParam

public static List<String> getSchemasUsedOnlyInFormParam(io.swagger.v3.oas.models.OpenAPI openAPI)

Return the list of schemas in the 'components/schemas' used only in a 'application/x-www-form-urlencoded' or 'multipart/form-data' mime time

参数:

openAPI - specification

返回:

schemas a list of schemas

getSimpleRef

public static String getSimpleRef(String ref)

isObjectSchema

public static boolean isObjectSchema(io.swagger.v3.oas.models.media.Schema schema)

isComposedSchema

public static boolean isComposedSchema(io.swagger.v3.oas.models.media.Schema schema)

isMapSchema

public static boolean isMapSchema(io.swagger.v3.oas.models.media.Schema schema)

isArraySchema

public static boolean isArraySchema(io.swagger.v3.oas.models.media.Schema schema)

isStringSchema

public static boolean isStringSchema(io.swagger.v3.oas.models.media.Schema schema)

isIntegerSchema

public static boolean isIntegerSchema(io.swagger.v3.oas.models.media.Schema schema)

isShortchema

public static boolean isShortchema(io.swagger.v3.oas.models.media.Schema schema)

isLongSchema

public static boolean isLongSchema(io.swagger.v3.oas.models.media.Schema schema)

isBooleanSchema

public static boolean isBooleanSchema(io.swagger.v3.oas.models.media.Schema schema)

isNumberSchema

public static boolean isNumberSchema(io.swagger.v3.oas.models.media.Schema schema)

isFloatSchema

public static boolean isFloatSchema(io.swagger.v3.oas.models.media.Schema schema)

isDoubleSchema

public static boolean isDoubleSchema(io.swagger.v3.oas.models.media.Schema schema)

isDateSchema

public static boolean isDateSchema(io.swagger.v3.oas.models.media.Schema schema)

isDateTimeSchema

public static boolean isDateTimeSchema(io.swagger.v3.oas.models.media.Schema schema)

isPasswordSchema

public static boolean isPasswordSchema(io.swagger.v3.oas.models.media.Schema schema)

isByteArraySchema

public static boolean isByteArraySchema(io.swagger.v3.oas.models.media.Schema schema)

isBinarySchema

public static boolean isBinarySchema(io.swagger.v3.oas.models.media.Schema schema)

isFileSchema

public static boolean isFileSchema(io.swagger.v3.oas.models.media.Schema schema)

isUUIDSchema

public static boolean isUUIDSchema(io.swagger.v3.oas.models.media.Schema schema)

isEmailSchema

public static boolean isEmailSchema(io.swagger.v3.oas.models.media.Schema schema)

isModel

public static boolean isModel(io.swagger.v3.oas.models.media.Schema schema)

Check to see if the schema is a model with at least one properties

参数:

schema - potentially containing a '$ref'

返回:

true if it's a model with at least one properties

isFreeFormObject

public static boolean isFreeFormObject(io.swagger.v3.oas.models.media.Schema schema)

Check to see if the schema is a free form object

参数:

schema - potentially containing a '$ref'

返回:

true if it's a free-form object

getReferencedSchema

public static io.swagger.v3.oas.models.media.Schema getReferencedSchema(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                        io.swagger.v3.oas.models.media.Schema schema)

If a Schema contains a reference to another Schema with '$ref', returns the referenced Schema if it is found or the actual Schema in the other cases.

参数:

openAPI - specification being checked

schema - potentially containing a '$ref'

返回:

schema without '$ref'

getSchema

public static io.swagger.v3.oas.models.media.Schema getSchema(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                              String name)

getSchemas

public static Map<String,io.swagger.v3.oas.models.media.Schema> getSchemas(io.swagger.v3.oas.models.OpenAPI openAPI)

getReferencedRequestBody

public static io.swagger.v3.oas.models.parameters.RequestBody getReferencedRequestBody(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                                       io.swagger.v3.oas.models.parameters.RequestBody requestBody)

If a RequestBody contains a reference to an other RequestBody with '$ref', returns the referenced RequestBody if it is found or the actual RequestBody in the other cases.

参数:

openAPI - specification being checked

requestBody - potentially containing a '$ref'

返回:

requestBody without '$ref'

getRequestBody

public static io.swagger.v3.oas.models.parameters.RequestBody getRequestBody(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                             String name)

getReferencedApiResponse

public static io.swagger.v3.oas.models.responses.ApiResponse getReferencedApiResponse(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                                      io.swagger.v3.oas.models.responses.ApiResponse apiResponse)

If a ApiResponse contains a reference to an other ApiResponse with '$ref', returns the referenced ApiResponse if it is found or the actual ApiResponse in the other cases.

参数:

openAPI - specification being checked

apiResponse - potentially containing a '$ref'

返回:

apiResponse without '$ref'

getApiResponse

public static io.swagger.v3.oas.models.responses.ApiResponse getApiResponse(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                            String name)

getReferencedParameter

public static io.swagger.v3.oas.models.parameters.Parameter getReferencedParameter(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                                   io.swagger.v3.oas.models.parameters.Parameter parameter)

If a Parameter contains a reference to an other Parameter with '$ref', returns the referenced Parameter if it is found or the actual Parameter in the other cases.

参数:

openAPI - specification being checked

parameter - potentially containing a '$ref'

返回:

parameter without '$ref'

getParameter

public static io.swagger.v3.oas.models.parameters.Parameter getParameter(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                         String name)

getReferencedCallback

public static io.swagger.v3.oas.models.callbacks.Callback getReferencedCallback(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                                io.swagger.v3.oas.models.callbacks.Callback callback)

If a Callback contains a reference to an other Callback with '$ref', returns the referenced Callback if it is found or the actual Callback in the other cases.

参数:

openAPI - specification being checked

callback - potentially containing a '$ref'

返回:

callback without '$ref'

getCallback

public static io.swagger.v3.oas.models.callbacks.Callback getCallback(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                      String name)

getSchemaFromRequestBody

public static io.swagger.v3.oas.models.media.Schema getSchemaFromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody requestBody)

Return the first defined Schema for a RequestBody

参数:

requestBody - request body of the operation

返回:

firstSchema

getSchemaFromResponse

public static io.swagger.v3.oas.models.media.Schema getSchemaFromResponse(io.swagger.v3.oas.models.responses.ApiResponse response)

Return the first defined Schema for a ApiResponse

参数:

response - api response of the operation

返回:

firstSchema

unaliasSchema

public static io.swagger.v3.oas.models.media.Schema unaliasSchema(Map<String,io.swagger.v3.oas.models.media.Schema> allSchemas,
                                                                  io.swagger.v3.oas.models.media.Schema schema)

Get the actual schema from aliases. If the provided schema is not an alias, the schema itself will be returned.

参数:

allSchemas - all schemas

schema - schema (alias or direct reference)

返回:

actual schema

getAdditionalProperties

public static io.swagger.v3.oas.models.media.Schema getAdditionalProperties(io.swagger.v3.oas.models.media.Schema schema)

getReferencedHeader

public static io.swagger.v3.oas.models.headers.Header getReferencedHeader(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                          io.swagger.v3.oas.models.headers.Header header)

getHeader

public static io.swagger.v3.oas.models.headers.Header getHeader(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                String name)