Utils

flaskerk.utils.abort_json(code: int, msg: str = '')

abort as a JSON response

Parameters

• code (int) – HTTP status code

• msg (str) – description for this abort

flaskerk.utils.get_converter(converter: str, *args, **kwargs)

Get conveter method from converter map

Parameters

• converter – str: converter type

• args –

• kwargs –

Returns

return schema dict

flaskerk.utils.get_summary_desc(func)

get summary, description from func.__doc__

Summary and description are split by ‘

‘. If only one is provided,

it will be used as summary.

flaskerk.utils.parse_url(path: str)

Parsing Flask route url to get the normal url path and parameter type.

Based on Werkzeug builtin converters.

flaskerk.converters.convert_any(*args, **kwargs)

Handle converter type “any”

Parameters

• args –

• kwargs –

Returns

return schema dict

flaskerk.converters.convert_default(*args, **kwargs)

Handle converter type “default”

Parameters

• args –

• kwargs –

Returns

return schema dict

flaskerk.converters.convert_float(*args, **kwargs)

Handle converter type “float”

Parameters

• args –

• kwargs –

Returns

return schema dict

flaskerk.converters.convert_int(*args, **kwargs)

Handle converter type “int”

Parameters

• args –

• kwargs –

Returns

return schema dict

flaskerk.converters.convert_path(*args, **kwargs)

Handle converter type “path”

Parameters

• args –

• kwargs –

Returns

return schema dict

flaskerk.converters.convert_string(*args, **kwargs)

Handle converter type “string”

Parameters

• args –

• kwargs –

Returns

return schema dict

flaskerk.converters.convert_uuid(*args, **kwargs)

Handle converter type “uuid”

Parameters

• args –

• kwargs –

Returns

return schema dict