Add examples to the docs?

[C-Loftus]

Hello all, thank you very much for all the work on stac-fastapi

I was wondering if there are any small example apps that I could reference. In the docs I see documentation for the Python API, but not any examples of how to incorporate it in an existing fastapi project. I have an existing fast api app and I would like to incorperate stac-fastapi but I am a bit unsure best practices for setting up the project and various configuration settings.

[jonhealy1]

I'm not sure this would be a common use-case. Usually stac-fastapi implementations are stand-alone I think. Here's an example that may help. If you need more, have a look at how it is set up here for example.

from fastapi import FastAPI
from stac_fastapi.api.app import StacApi
from stac_fastapi.types.config import ApiSettings

# 1. Import the Transaction Extension
from stac_fastapi.extensions.core import TransactionExtension

# 2. Import your specific backend clients (using pgstac as a hypothetical example)
# from stac_fastapi.pgstac.core import CoreCrudClient
# from stac_fastapi.pgstac.transactions import TransactionsClient

# --- Your Existing Application ---
main_app = FastAPI(title="My Custom Application")

@main_app.get("/custom-route")
async def custom_route():
    return {"message": "This is outside the STAC API"}

# --- STAC API Setup ---
settings = ApiSettings()

# 3. Initialize your database clients
# core_client = CoreCrudClient(...)
# txn_client = TransactionsClient(...)

# 4. Initialize the extension with its specific client
transaction_extension = TransactionExtension(
    client=txn_client,
    settings=settings
)

# 5. Build the STAC API
stac_api = StacApi(
    settings=settings,
    client=core_client, # Handles GET /search, GET /collections, etc.
    extensions=[
        transaction_extension # Injects POST /collections, POST /items, etc.
    ],
)

# --- The Integration ---
# Mount the STAC API under the "/stac" prefix
main_app.mount("/stac", stac_api.app)

[jonhealy1]

Are you wanting to run your own code, database for stac-fastapi or would you use stac-fastapi-pgstac or stac-fastapi-elasticsearch-opensearch and just connect it to your existing fastapi implementation?

[C-Loftus]

Thanks for your response! That makes sense

Usually stac-fastapi implementations are stand-alone I think.

Ah that makes more sense now. I think I have misinterpreted some of the goals of the project.

Are you wanting to run your own code, database for stac-fastapi or would you use stac-fastapi-pgstac or stac-fastapi-elasticsearch-opensearch and just connect it to your existing fastapi implementation?

I think at the moment I am mainly just trying to explore options and potentially use a custom backend. My STAC catalog would be rather small so was trying to figure out what would be easiest to spin up and most minimal to maintain.

Regarding my current infrastructure, you are correct, I have an existing fast api application that I use for a few OGC API implementations, so it would be easiest for me to add the stac API routes to that existing app without spinning up new infrastructure for another server.

[jonhealy1]

Are you presently running a database with your api?