Welcome to bluebird-api
The bluebird-api package is a FastAPI app that gives access to the bluebird-dt digital twin via a REST API.
Terminology
In this context, API means the HTTP interface used by agents and frontends (including the HMI GUI) to interact with a running simulation.
Using the pre-built API
The API package is part of this repository, so you can run it directly from source without creating a separate service scaffold.
- From the
BluebirdATC/bluebird-apidirectory, start the server:
uv run uvicorn bluebird_api:app --port 8000
-
Check the root endpoint in your browser: http://localhost:8000
-
Open the interactive API docs (Swagger UI): http://localhost:8000/docs
-
If you also want the GUI, open the HMI served by the API: http://localhost:8000/hmi
Developer Guide
Running locally
Run the API service locally:
cd bluebird-api
uv run uvicorn bluebird_api:app --port 8000
Running tests and checks
Run the API test suite from the package directory:
cd bluebird-api
uv run pytest
To use parallel workers:
cd bluebird-api
uv run pytest -n auto
Source README
For package-level details, see the source README: