FastAPI Web 应用程序课程项目教程

FastAPI Web 应用程序课程项目教程

web-applications-with-fastapi-course Demo code and other handouts for students of our FastAPI Web Apps course. 项目地址: https://gitcode.com/gh_mirrors/we/web-applications-with-fastapi-course

1. 项目目录结构及介绍

web-applications-with-fastapi-course/
├── code/
│   ├── __init__.py
│   ├── main.py
│   ├── ...
├── data/
│   ├── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── revisions.md
├── ruff.toml

目录结构说明

• code/: 包含项目的核心代码文件，如 main.py 等。
• data/: 存放项目所需的数据文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• requirements.txt: 项目依赖包列表。
• revisions.md: 项目版本更新记录。
• ruff.toml: 项目配置文件，可能用于代码风格检查等。

2. 项目启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化 FastAPI 应用并启动服务器。以下是 main.py 的基本结构：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

启动方式

在项目根目录下运行以下命令启动 FastAPI 应用：

uvicorn code.main:app --reload

3. 项目配置文件介绍

requirements.txt

requirements.txt 文件列出了项目所需的所有 Python 依赖包。以下是一个示例：

fastapi==0.68.1
uvicorn==0.15.0
SQLAlchemy==1.4.23

ruff.toml

ruff.toml 文件用于配置代码风格检查工具 Ruff。以下是一个示例配置：

[tool.ruff]
line-length = 88
select = ["E", "F"]
ignore = ["W503"]

LICENSE

LICENSE 文件包含了项目的开源许可证信息，通常为 MIT 许可证。

README.md

README.md 文件提供了项目的详细介绍、安装步骤、使用说明等信息。

---

以上是基于 web-applications-with-fastapi-course 项目的教程内容，涵盖了项目的目录结构、启动文件和配置文件的介绍。

web-applications-with-fastapi-course Demo code and other handouts for students of our FastAPI Web Apps course. 项目地址: https://gitcode.com/gh_mirrors/we/web-applications-with-fastapi-course