检查Python版本#

1
# Windows
2
python -V
3
# Linux
4
python3 -V

创建并启动环境#

1. 创建环境#

   进入你为项目准备的文件夹，调用python命令为项目创建一个虚拟环境。隔离开发环境和全局环境，保护全局干净不会出现异常情况。

   1
   python -m venv .venv
   

   命令执行完后，文件夹下会出现一个.venv文件夹。这是局部python环境的文件夹，里面有着三个文件夹和一个配置文件，分别是Include、Lib、Scripts和pyvenv.cfg。

2. 启动环境#

   启动环境只需要调用Scripts下的activate

   1
   # Linux:
   2
   source .\.venv\Scripts\activate.bat
   3
   # Windows:
   4
   & .\.venv\Scripts\Activate.ps1
   

3. 检查环境#

   检查虚拟环境是否已激活（前面的命令是否生效）。

   1
   > which python
   2
   你的文件夹路径/.venv/bin/python
   

   如果显示出你的项目文件夹加上虚拟环境的Python文件路径，则表示成功。

安装FastAPI并测试#

创建完虚拟环境后就可以安全的安装FastAPI框架了。

1
pip install "fastapi[standard]"

注意：请确保将 "fastapi[standard]" 放在引号中，以确保它在所有终端中都能正常工作。

创建main.py，并写入以下内容。

1
from fastapi import FastAPI
2

3
app = FastAPI()
4

5
@app.get("/")
6
async def root():
7
  return {
8
    "message":"Hello World"
9
  }

运行fastapi dev main.py

访问127.0.0.1:8000，如果出现以下内容即为成功

1
{"message":"Hello World"}

成功后可以对当前项目进行一个收尾

1
# 执行以下命令导出Python环境所有包到requirements文件
2
pip freeze > requirements.txt

自动生成文档功能#

现在访问 http://127.0.0.1:8000/docs。

您将看到自动交互式 API 文档

或者访问 http://127.0.0.1:8000/redoc。

您将看到备选的自动文档