FastAPI Link Types

Complete reference for all link types supported by the FastAPI component

Outbound - FastAPI connects TO these
Inbound - These connect TO FastAPI

🗄️ Database Links OUTBOUND

Link Type Description Environment Variables Generated Files
fastapi-database
PostgreSQL
 Connect to PostgreSQL for relational data storage POSTGRES_HOST, POSTGRES_PORT, POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD
📁 src/postgresql_module/
Connection helpers & models
fastapi-db
CNPG (Cloud Native PG)
 Connect to CNPG-managed PostgreSQL cluster CNPG_HOST, CNPG_PORT, CNPG_DB, CNPG_USER, CNPG_PASSWORD
📁 src/postgresql_module/
Connection helpers & models
fastapi-mongo_db
MongoDB
 Connect to MongoDB for document storage MONGODB_HOST, MONGODB_PORT, MONGODB_DB, MONGODB_USER, MONGODB_PASSWORD
📁 src/mongodb_module/
Connection helpers & models

📨 Messaging Links OUTBOUND

Link Type Description Environment Variables Generated Files
fastapi-exchange
RabbitMQ Exchange
 Publish messages to RabbitMQ exchange RABBITMQ_HOST, RABBITMQ_PORT, RABBITMQ_USER, RABBITMQ_PASSWORD, RABBITMQ_EXCHANGE
📁 src/rabbitmq_module/
Publisher helpers
fastapi-queue
RabbitMQ Queue
 Consume messages from RabbitMQ queue RABBITMQ_HOST, RABBITMQ_PORT, RABBITMQ_USER, RABBITMQ_PASSWORD, RABBITMQ_QUEUE
📁 src/rabbitmq_module/
Consumer helpers
fastapi-topic
Kafka Topic
 Produce/consume Kafka messages KAFKA_BOOTSTRAP_SERVERS, KAFKA_TOPIC, KAFKA_CONSUMER_GROUP
📁 src/kafka_module/
Producer & consumer helpers

📦 Storage Links OUTBOUND

Link Type Description Environment Variables Generated Files
fastapi-bucket
MinIO Bucket
 S3-compatible object storage S3_ENDPOINT, S3_BUCKET, S3_ACCESS_KEY, S3_SECRET_KEY
📁 src/minio_module/
S3 client helpers
fastapi-swbucket
SeaweedFS Bucket
 Distributed S3-compatible storage S3_ENDPOINT, S3_BUCKET, S3_ACCESS_KEY, S3_SECRET_KEY, S3_REGION
📁 src/minio_module/
S3 client helpers

🔧 Infrastructure Links INBOUND

Link Type Description Configurable Options Generated Files
prometheus-fastapi
Metrics Monitoring
 Enable Prometheus scraping at /metrics scrape_interval, port, path
📄 monitoring.yaml
ServiceMonitor CR
apisix-fastapi
API Gateway
 Expose via APISIX with routing & auth subdomain, path, cors, rate_limit, auth, timeout
📄 route.yaml
ApisixRoute CR
gateway-fastapi
Kubernetes Ingress
 External HTTPS access via Ingress subdomain, cors, rate_limiting
📄 ingress.yaml, cors.yaml, rate-limit.yaml
Ingress + optional policies
istio-fastapi
Service Mesh
 Istio traffic management & security traffic_policy, mtls, timeout
📄 virtualservice.yaml, destinationrule.yaml
Istio CRs

⚡ Quick Reference

Generated Python Modules

📁 postgresql_module/ - DB connection, queries
📁 mongodb_module/ - Mongo client helpers
📁 rabbitmq_module/ - Publisher/consumer
📁 minio_module/ - S3 operations
📁 kafka_module/ - Kafka producer/consumer

Generated Kubernetes Files

📄 monitoring.yaml - ServiceMonitor
📄 ingress.yaml - External access
📄 route.yaml - APISIX routing
📄 cors.yaml - CORS policy
📄 rate-limit.yaml - Rate limiting