kandance / simple-fastapi-azure-function

Simple HTTP API using FastAPI framework, deployed to Azure Functions using Azure Developer CLI.

This repository includes a very simple Python Flask HTTP API, made for demonstration purposes only.

Local development: FastAPI

1. Open this repository in Github Codespaces or VS Code with Remote Devcontainers extension.
2. Open the Terminal and navigate to the api directory.

cd api

2. Use uvicorn to run the FastAPI app:

uvicorn main:app --reload

3. Click 'http://127.0.0.1:8000' in the terminal, which should open the website in a new tab.
4. Append /generate_name to the end of the URL.

Local development: Azure Functions

Since this project is designed to be deployed to Azure Functions, you can also use the local emulator from Azure Functions Core Tools to test the function locally.

1. Open this repository in Github Codespaces or VS Code with Remote Devcontainers extension.
2. Open the Terminal and make sure you're in the root folder (simple-fastapi-azure-function).
3. Run func host start
4. Click 'http://localhost:7071/{*route}' in the terminal, which should open the website in a new tab.
5. Change the URL to navigate to either the API at /generate_name or the docs at /docs.

Deployment

Run azd up.

Navigate to the endpoint displayed in the terminal.

To try API v1, append /generate_name to the end of the URL.