FastAPI

This sample project demonstrates how to deploy FastAPI with Defang.

Prerequisites

1. Download Defang CLI
2. (Optional) If you are using Defang BYOC authenticate with your cloud provider account
3. (Optional for local development) Docker CLI

Development

To run the application locally, you can use the following command:

docker compose -f compose.yaml -f compose.dev.yaml up --build

Configuration

For this sample, you will not need to provide configuration.

If you wish to provide configuration, see below for an example of setting a configuration for a value named API_KEY.

defang config set API_KEY

Deployment

Note

Download Defang CLI

Defang Playground

Deploy your application to the Defang Playground by opening up your terminal and typing:

defang compose up

BYOC (AWS)

If you want to deploy to your own cloud account, you can use Defang BYOC:

1. Authenticate your AWS account, and check that you have properly set your environment variables like AWS_PROFILE, AWS_REGION, AWS_ACCESS_KEY_ID, and AWS_SECRET_ACCESS_KEY.
2. Run in a terminal that has access to your AWS environment variables:

   defang --provider=aws compose up

---

Title: FastAPI

Short Description: A sample project demonstrating how to deploy FastAPI with Defang.

Tags: FastAPI, OpenAPI, Python

Languages: python