HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

fastapi — Run FastAPI apps which uses Uvicorn under the hood. More information: <https://manned.org/fastapi>.

Submitted by: @import:tldr-pages··
0
Viewed 0 times
commandrunfastapiappscliwhichuses

Problem

How to use the fastapi command: Run FastAPI apps which uses Uvicorn under the hood. More information: <https://manned.org/fastapi>.

Solution

fastapi — Run FastAPI apps which uses Uvicorn under the hood. More information: <https://manned.org/fastapi>.

Run a FastAPI app with automatic reload (for development):
fastapi run {{path/to/file.py}} --reload


Serve your app in both development mode:
fastapi dev {{path/to/file.py}}


Specify the host and port to run on:
fastapi run {{path/to/file.py}} --host {{host_address}} --port {{port}}


Set the app variable name (if not app) or specify a custom app directory:
fastapi run {{path/to/file.py}} --app-dir {{path/to/app}} --app {{custom_app_name}}


Display help:
fastapi --help


Display help for a subcommand:
fastapi {{subcommand}} --help

Code Snippets

Run a FastAPI app with automatic reload (for development)

fastapi run {{path/to/file.py}} --reload

Serve your app in both development mode

fastapi dev {{path/to/file.py}}

Specify the host and port to run on

fastapi run {{path/to/file.py}} --host {{host_address}} --port {{port}}

Set the app variable name (if not `app`) or specify a custom app directory

fastapi run {{path/to/file.py}} --app-dir {{path/to/app}} --app {{custom_app_name}}

Display help

fastapi --help

Context

tldr-pages: common/fastapi

Revisions (0)

No revisions yet.