Skip to content

myAPI Documentation

Documentation for myAPI using FastAPI, Pydantic Settings and Uvicorn.

Initial deployment

Create the initial documentation.

  • Initialize the Python virtual environment if required
uv init --bare .
  • Install FastAPI and dependencies.
uv add fastapi pydantic-settings 'uvicorn[standard]'
uv add --dev black

Run server

uv run uvicorn --app-dir ./src api:get_api --host 0.0.0.0 --port 8000 --factory --reload --reload-include .env

Run tests

  • Run Pytest
uv run pytest -v