OpenAPI

get_argument(argument_type, argument_name)

Make argument from given type and name.

Source code in apiflask/openapi.py

def get_argument(argument_type: str, argument_name: str) -> dict[str, t.Any]:
    """Make argument from given type and name."""
    argument: dict[str, t.Any] = {
        'in': 'path',
        'name': argument_name,
    }
    if argument_type == 'int:':
        argument['schema'] = {'type': 'integer'}
    elif argument_type == 'float:':
        argument['schema'] = {'type': 'number'}
    else:
        argument['schema'] = {'type': 'string'}
    return argument

get_default_response()

Get a default 200 response object.

Source code in apiflask/openapi.py

def get_default_response() -> dict[str, t.Any]:
    """Get a default 200 response object."""
    default_response = {
        'schema': {},
        'status_code': 200,
        'description': None,
        'example': None,
        'examples': None,
        'links': None,
        'content_type': 'application/json',
        'headers': None,
    }
    return default_response

get_operation_tags(blueprint, blueprint_name)

Get operation tag from blueprint object.

Source code in apiflask/openapi.py

def get_operation_tags(blueprint: APIBlueprint, blueprint_name: str) -> list[str]:
    """Get operation tag from blueprint object."""
    tags: list[str]
    if blueprint.tag is not None:
        if isinstance(blueprint.tag, dict):
            tags = [blueprint.tag['name']]
        else:
            tags = [blueprint.tag]
    else:
        tags = [blueprint_name.title()]
    return tags

get_path_description(func)

Get path description from the docstring of the view function.

Source code in apiflask/openapi.py

def get_path_description(func: t.Callable) -> str:
    """Get path description from the docstring of the view function."""
    docs = (func.__doc__ or '').strip().split('\n')
    if len(docs) > 1:
        # use the remain lines of docstring as description
        return '\n'.join(docs[1:]).strip()
    return ''

get_path_summary(func, fallback=None)

Get path summary from the name or docstring of the view function.

Source code in apiflask/openapi.py

def get_path_summary(func: t.Callable, fallback: str | None = None) -> str:
    """Get path summary from the name or docstring of the view function."""
    summary: str
    docs: list = (func.__doc__ or '').strip().split('\n')
    if docs[0]:
        # Use the first line of docstring
        summary = docs[0]
    else:
        # Use the function name
        summary = fallback or ' '.join(func.__name__.split('_')).title()
    return summary

get_security_and_security_schemes(auth_names, auth_schemes)

Make security and security schemes from given auth names and schemes.

Source code in apiflask/openapi.py

def get_security_and_security_schemes(
    auth_names: list[str], auth_schemes: list[HTTPAuthType]
) -> tuple[dict[HTTPAuthType, str], dict[str, dict[str, str]]]:
    """Make security and security schemes from given auth names and schemes."""
    security: dict[HTTPAuthType, str] = {}
    security_schemes: dict[str, dict[str, str]] = {}
    for name, auth in zip(auth_names, auth_schemes):  # noqa: B905
        security[auth] = name
        security_schemes[name] = auth.get_security_scheme()
    return security, security_schemes

get_tag(blueprint, blueprint_name)

Get tag from blueprint object.

Source code in apiflask/openapi.py

def get_tag(blueprint: APIBlueprint, blueprint_name: str) -> dict[str, t.Any]:
    """Get tag from blueprint object."""
    tag: dict[str, t.Any]
    if blueprint.tag is not None:
        if isinstance(blueprint.tag, dict):
            tag = blueprint.tag
        else:
            tag = {'name': blueprint.tag}
    else:
        tag = {'name': blueprint_name.title()}
    return tag