FastAPI 服务抽象化项目教程

FastAPI 服务抽象化项目教程

1. 项目的目录结构及介绍

abstracting-fastapi-services/
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   └── ...
├── tests/
│   ├── __init__.py
│   └── ...
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── poetry.lock
└── pyproject.toml

• app/: 包含应用程序的主要代码。
  • __init__.py: 包初始化文件。
  • main.py: 应用程序的入口文件。
  • config.py: 配置文件。
• tests/: 包含测试代码。
• .gitignore: Git忽略文件。
• LICENSE: 项目许可证。
• Makefile: 包含构建和运行项目的命令。
• README.md: 项目说明文档。
• poetry.lock: Poetry依赖锁定文件。
• pyproject.toml: 项目配置文件。

2. 项目的启动文件介绍

app/main.py 是项目的启动文件，负责初始化FastAPI应用并启动服务器。以下是简要代码示例：

from fastapi import FastAPI

app = FastAPI()

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

3. 项目的配置文件介绍

pyproject.toml 是项目的配置文件，使用Poetry进行依赖管理。以下是简要配置示例：

[tool.poetry]
name = "abstracting-fastapi-services"
version = "0.1.0"
description = "FastAPI application and service structure for a more maintainable codebase"
authors = ["Camillo Visini <camillo.visini@gmail.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"
fastapi = "^0.68.0"
uvicorn = "^0.15.0"

[tool.poetry.dev-dependencies]
pytest = "^6.2.4"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

• [tool.poetry]: 项目基本信息。
• [tool.poetry.dependencies]: 项目依赖。
• [tool.poetry.dev-dependencies]: 开发依赖。
• [build-system]: 构建系统配置。