Watch-FastAPI 项目教程

Watch-FastAPI 项目教程

1. 项目介绍

Watch-FastAPI 是一个仿 HelloFlask 项目的开源项目，采用前后端分离架构，前端使用 Vue3 + Vite2，后端使用 FastAPI + Tortoise ORM + SQLite。该项目旨在提供一个实时监控 FastAPI 应用的工具，帮助开发者快速查看日志、请求统计、路由信息等关键数据，从而辅助调试和优化应用。

2. 项目快速启动

2.1 环境准备

确保你已经安装了 Docker 和 Docker Compose。如果没有安装，请参考官方文档进行安装。

2.2 克隆项目

git clone https://github.com/zy7y/watch-fastapi.git
cd watch-fastapi

2.3 启动项目

使用 Docker Compose 启动项目：

docker-compose up -d

2.4 访问应用

启动成功后，可以通过以下地址访问应用：

• 后端：http://localhost:1339
• 前端：http://localhost:2153

3. 应用案例和最佳实践

3.1 开发阶段

在开发阶段，开发者可以通过 Watch-FastAPI 快速查看日志，即时发现潜在问题。例如，当某个接口响应时间过长时，可以通过请求统计功能快速定位性能瓶颈。

3.2 调试接口

在调试接口时，通过查看请求统计，可以知道哪个接口响应慢，有助于优化性能。例如，可以通过路由详情功能查看所有可用的路由及其元数据，包括 HTTP 方法、路径和描述。

3.3 多路由应用管理

对于多路由的应用，路由详情功能能帮助你更好地管理 API。例如，可以通过自定义扩展功能添加自定义监听器，扩展到其他你需要监控的领域。

4. 典型生态项目

4.1 FastAPI

FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，基于 Python 3.7+ 标准类型提示。它具有快速开发、高性能、易于使用和生产就绪等特点。

4.2 Vue.js

Vue.js 是一个用于构建用户界面的渐进式 JavaScript 框架。它易于上手，并且可以与现有项目无缝集成。Vue3 是 Vue.js 的最新版本，提供了更好的性能和更丰富的功能。

4.3 Tortoise ORM

Tortoise ORM 是一个异步 ORM，旨在与 Python 的 asyncio 一起使用。它提供了类似于 Django ORM 的 API，但具有更好的性能和更灵活的配置。

4.4 SQLite

SQLite 是一个轻量级的嵌入式数据库，广泛用于移动设备和嵌入式系统。它不需要单独的服务器进程，数据存储在一个单一的文件中，非常适合小型应用。

通过以上模块的介绍和实践，你可以快速上手 Watch-FastAPI 项目，并将其应用于实际开发中。