FastAPI异步API开发与测试指南

FastAPI异步API开发与测试指南

fastapi-crud-async FastAPI CRUD 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-crud-async

1. 安装指南

环境要求

• Docker v20.10.21
• Python v3.11.0
• pytest v7.2.0
• Databases v0.6.2

安装步骤

1. 克隆项目：

   git clone https://github.com/your-repo/fastapi-crud.git
   cd fastapi-crud
   

2. 构建并运行Docker容器：

   docker-compose up -d --build
   

3. 验证安装： 打开浏览器访问以下URL以验证服务是否正常运行：

   • http://localhost:8002/ping
   • http://localhost:8002/docs
   • http://localhost:8002/notes

2. 项目使用说明

启动服务

通过Docker Compose启动服务后，FastAPI应用将在http://localhost:8002上运行。你可以通过访问/ping路由来检查服务是否正常运行。

访问API文档

FastAPI内置了Swagger UI，你可以通过访问/docs路由来查看和测试API文档。

数据库交互

项目使用Postgres数据库进行数据存储，通过Databases包实现异步数据库交互。数据库配置在docker-compose.yml中定义。

3. 项目API使用文档

主要API路由

1. GET /ping

   • 描述：检查服务是否正常运行。
   • 响应：返回一个简单的JSON响应，表示服务正在运行。

2. GET /docs

   • 描述：访问Swagger UI文档页面。
   • 响应：返回Swagger UI页面，展示所有API接口及其使用方法。

3. GET /notes

   • 描述：获取所有笔记。
   • 响应：返回一个包含所有笔记的JSON数组。

4. POST /notes

   • 描述：创建新笔记。
   • 请求体：JSON对象，包含笔记内容。
   • 响应：返回创建的笔记的详细信息。

5. PUT /notes/{note_id}

   • 描述：更新指定ID的笔记。
   • 请求体：JSON对象，包含更新后的笔记内容。
   • 响应：返回更新后的笔记详细信息。

6. DELETE /notes/{note_id}

   • 描述：删除指定ID的笔记。
   • 响应：返回删除操作的状态信息。

4. 项目安装方式

使用Docker Compose

项目推荐使用Docker Compose进行安装和运行。通过以下命令可以快速构建并启动服务：

docker-compose up -d --build

手动安装

如果你不想使用Docker，可以手动安装依赖并运行项目：

1. 安装依赖：

   pip install -r requirements.txt
   

2. 启动应用：

   uvicorn app.main:app --reload
   

通过以上步骤，你可以顺利安装并使用本项目进行异步API的开发与测试。

fastapi-crud-async FastAPI CRUD 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-crud-async