Skip to content

Module stac_fastapi.opensearch.app

FastAPI application.

Variables

handler
logger
sentry_enable

Functions

create_app

def create_app(

) -> fastapi.applications.FastAPI

Create a new FastAPI application instance using the factory pattern.

This function is designed to be used with Uvicorn's --factory flag: uvicorn stac_fastapi.opensearch.app:create_app --factory

Returns:

Type Description
FastAPI A fresh FastAPI application instance with all routes configured.

create_handler

def create_handler(
    app: fastapi.applications.FastAPI
)

Create a handler to use with AWS Lambda if mangum available.

instantiate_api

def instantiate_api(
    settings: stac_fastapi.opensearch.config.OpensearchSettings | None = None,
    database_logic: stac_fastapi.opensearch.database_logic.DatabaseLogic | None = None,
    extensions_manager: stac_fastapi.sfeos_helpers.models.extensions.Extensions | None = None
) -> stac_fastapi.api.app.StacApi

Instantiate the OpenSearch-backed STAC API.

run

def run(

) -> None

Run app from command line using uvicorn if available.