logo
0
0
WeChat Login

Spell Smart AI Coach Backend

基于FastAPI的智能拼写教练后端服务

项目结构

spell-smart-ai-coach-baackend/
├── app/
│   ├── __init__.py
│   ├── api/
│   │   ├── __init__.py
│   │   └── v1/
│   │       ├── __init__.py
│   │       ├── api.py
│   │       └── endpoints/
│   │           ├── __init__.py
│   │           └── hello_world.py
│   ├── core/
│   │   ├── __init__.py
│   │   └── config.py
│   ├── crud/
│   │   ├── __init__.py
│   │   └── hello_world.py
│   ├── db/
│   │   ├── __init__.py
│   │   ├── database.py
│   │   └── models.py
│   └── schemas/
│       ├── __init__.py
│       └── hello_world.py
├── docs/
│   └── changelog.md
├── main.py
├── requirements.txt
└── README.md

功能特性

  • FastAPI框架,自动生成API文档
  • PostgreSQL数据库支持
  • SQLAlchemy ORM
  • Pydantic数据验证
  • CORS中间件支持
  • Hello World示例API

安装依赖

方案1:使用psycopg2-binary(推荐)

pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/

方案2:如果psycopg2-binary安装失败,使用asyncpg

pip install -r requirements_asyncpg.txt -i https://mirrors.aliyun.com/pypi/simple/

方案3:使用安装脚本(Windows)

install_dependencies.bat

注意:如果遇到psycopg2-binary安装问题,请参考 故障排除指南

运行应用

python main.py

或使用uvicorn:

uvicorn main:app --host 0.0.0.0 --port 8000 --reload

API文档

启动应用后,访问以下地址查看API文档:

Hello World API

获取简单Hello World消息

  • GET /api/v1/hello-world/hello
  • 返回简单的Hello World消息和时间戳

创建Hello World记录

  • POST /api/v1/hello-world/hello
  • 在数据库中创建Hello World记录

获取Hello World记录

  • GET /api/v1/hello-world/hello/{id}
  • 根据ID获取特定的Hello World记录

更新Hello World记录

  • PUT /api/v1/hello-world/hello/{id}
  • 更新指定ID的Hello World记录

删除Hello World记录

  • DELETE /api/v1/hello-world/hello/{id}
  • 删除指定ID的Hello World记录

数据库配置

数据库连接信息在 app/core/config.py 中配置:

  • 服务器: 101.37.166.27
  • 端口: 35432
  • 用户名: root
  • 密码: Ab123456
  • 数据库名: spell_coach

开发指南

请参考项目根目录下的开发指南文档,遵循代码规范和最佳实践。

About

智能学习英语拼写的应用

Language
Python61.4%
Markdown28.6%
gitignore9.5%
Others0.5%