src package

Subpackages

• src.endpoints package
  • Subpackages
    • src.endpoints.v1 package
      • Submodules
      • src.endpoints.v1.user module
      • src.endpoints.v1.version module
      • Module contents
  • Module contents
• src.scheme package
  • Submodules
  • src.scheme.user module
    • UserCreate
      • UserCreate.fullname
      • UserCreate.model_config
      • UserCreate.name
      • UserCreate.nickname
    • UserResponse
      • UserResponse.fullname
      • UserResponse.id
      • UserResponse.model_config
      • UserResponse.name
      • UserResponse.nickname
  • src.scheme.version module
    • VersionResponse
      • VersionResponse.model_config
      • VersionResponse.version
  • Module contents
• src.utils package
  • Submodules
  • src.utils.database module
    • Database
      • Database.db_path
      • Database.connection
      • Database.pytest_enabled
      • Database.engine
      • Database.connect()
      • Database.session()
      • Database.close()
      • Database.__del__()
      • Database.close()
      • Database.connect()
      • Database.connection
      • Database.db_path
      • Database.engine
      • Database.session()
  • Module contents

Submodules

src.app module

This module initializes and configures the FastAPI application.

If you want to change the title, description, version, or URLs of the API documentation, you can do so by modifying the values in the APIDetail class in the app_detail.py module.

src.app_detail module

This module contains the APIDetail class which provides metadata and configuration for the API.

class src.app_detail.APIDetail

Bases: object

APIDetail class contains metadata and configuration for the FastAPI Template API.

API_TITLE

The title of the API.

Type:

str

DESCRIPTION

A brief description of the API.

Type:

str

VERSION

The version of the API.

Type:

str

OPENAPI_URL

The URL path for the OpenAPI schema.

Type:

str

DOCS_URL

The URL path for the interactive API documentation (Swagger UI).

Type:

str

REDOC_URL

The URL path for the ReDoc documentation.

Type:

str

API_TITLE = 'FastAPI Template API'

DESCRIPTION = '\n        FastAPI Template API is a template for creating a FastAPI project.\n    '

DOCS_URL = '/docs'

OPENAPI_URL = '/openapi.json'

REDOC_URL = '/redoc'

VERSION = '1.0.0'

Module contents

FastAPI Application.