Botkeep
← All starters

FastAPI

A typed Python API with validated responses, a health route and OpenAPI documentation.

Open in configurator

Files generated locally. No credentials needed to download.

Before you start

Python 3.12 or 3.13 and a virtual environment.

Dependencies

  • FastAPI 0.141.1
  • Uvicorn 0.53.0
  • python-dotenv 1.2.3

Run locally

  1. 1

    Create and activate a virtual environment, then run python -m pip install -r requirements.txt.

  2. 2

    Copy .env.example to .env if you need a different port. Run python main.py.

  3. 3

    Check http://127.0.0.1:8000/health, /api/greeting and /docs. Invalid query values produce a validation response.

Environment checklist

HOSTOptional
Defaults to 127.0.0.1 locally. Use the interface required by your actual host.
PORTOptional
Local default: 8000. Use the allocated port when hosted.

What is not included

No authentication or database is included. Add authorization, rate limits and persistent storage before exposing private data. HTTP routing and TLS are not active in the Botkeep preview.

The configurator prepares files and settings. Confirm deployment, add your credentials in Environment and check Console to verify startup.

Official documentation

README.md

# FastAPI

A typed Python API with validated responses, a health route and OpenAPI documentation.

## Requirements
Python 3.12 or 3.13 and a virtual environment.

## Setup
1. Create and activate a virtual environment, then run python -m pip install -r requirements.txt.
2. Copy .env.example to .env if you need a different port. Run python main.py.
3. Check http://127.0.0.1:8000/health, /api/greeting and /docs. Invalid query values produce a validation response.

## Variables
- HOST: Defaults to 127.0.0.1 locally. Use the interface required by your actual host.
- PORT: Local default: 8000. Use the allocated port when hosted.

## Boundaries
No authentication or database is included. Add authorization, rate limits and persistent storage before exposing private data. HTTP routing and TLS are not active in the Botkeep preview.

Downloading does not deploy anything. The Botkeep preview stores files in your browser but does not execute processes, install packages or activate networking. Do not enter real credentials in the demo. Direct dependencies are versioned: keep generated lockfiles and review updates and vulnerabilities before production.

## Sources
- FastAPI: https://fastapi.tiangolo.com/tutorial/first-steps/