Setup a FastAPI Server (Python)

WayScript allows you to configure your Lair to host a running microservice in minutes. Follow this guide to set up a simple FastAPI app in your Lair.

Create or load FastAPI files

Use the boilerplate code below to create a file in your Lair’s root directory. Or if you have an existing FastAPI project, copy or clone your project files into your Lair’s directory. See File system for more details on how to manipulate files in your workspace file system.

Set Up

from fastapi import FastAPI
# Creates our FastAPI application
app = FastAPI()
# Home route
# returns JSON response of dictionary after the return statement
def home():
return {'data': 'Hello world'}

Add packages to requirements.txt

Create a requirements.txt file in your Lair’s root directory and specify the fastapi and uvicorn packages. You can do so by pip installing them in your WayScript Terminal. You can also specify any additional dependencies your app requires. See Hosted environments for more details.
pip install fastapi
pip install uvicorn
pip freeze > requirements.txt

Configure deploy trigger

Open your Lair’s .triggers file and add a new deploy trigger. Create a name for your trigger and input the following run command and port number 8080 (or modified command and port number based on your app requirements). See Triggers for more details.
python -m uvicorn main:app --reload --host --port 8080
Press the play button on your triggers table to execute the run command and start your web server process (see Processes for more details). Navigate to the * endpoint generated to see your FastAPI app in action!

Deploy to production environment

Once you have finished testing, press “Deploy” to create a production environment for your FastAPI app. Select <Lair_name>.prod in the Lair selector menu and view the on deploy trigger to access your app’s production endpoint. See Hosted environments for more details.
By default, your Lair's endpoints are protected against unauthenticated requests. See Endpoints on how to public expose your endpoints or authenticate using your application key.
For a cloneable version of a FastAPI lair, see this template.