thatthep/fastapi-echo

镜像概述

本镜像提供一个基于FastAPI框架构建的轻量级echo服务，核心功能是接收客户端发送的各类HTTP请求，并将请求的完整信息（包括请求方法、路径、参数、头信息及请求体等）以结构化JSON格式返回。适用于API调试、请求验证及FastAPI学习场景。

核心功能与特性

• 轻量级架构：基于FastAPI和Uvicorn构建，镜像体积小，资源占用低，启动速度快
• 全请求捕获：支持捕获GET、POST、PUT、DELETE等所有HTTP方法的请求信息
• 结构化响应：统一返回JSON格式数据，包含请求元数据（方法、路径）和具体内容（参数、头信息、请求体）
• 即开即用：无需复杂配置，部署后可直接提供服务，降低使用门槛

使用场景

• API调试工具：快速验证客户端请求格式、参数传递是否符合预期
• 请求内容分析：查看完整请求详情（如头信息、表单数据、JSON体），辅助排查接口通信问题
• FastAPI学习案例：作为基础示例，帮助理解FastAPI的路由定义、请求处理及响应构建逻辑
• 服务可用性测试：作为最小化后端服务，验证容器化部署流程或网络连通性

使用方法

基本部署（docker run）

通过以下命令启动echo服务容器：

bash
docker run -d -p 8000:8000 --name fastapi-echo-service <镜像名称>

参数说明：

• -d：后台运行容器
• -p 8000:8000：端口映射（主机端口:容器端口），默认使用8000端口
• --name：指定容器名称，便于后续管理
• <镜像名称>：替换为实际Docker镜像标签（如my-echo-service:latest）

Docker Compose部署

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  echo-service:
    image: <镜像名称>
    ports:
      - "8000:8000"  # 端口映射配置
    restart: always  # 容器退出后自动重启

启动服务：

bash
docker-compose up -d

配置说明

环境变量

支持通过环境变量自定义服务配置：

自定义端口示例：

bash
docker run -d -p 8888:8888 -e PORT=8888 --name echo-service <镜像名称>

请求示例

服务启动后，可通过以下方式测试：

GET请求测试

bash
curl "http://localhost:8000/echo?user=test&age=20"

响应示例：

json
{
  "method": "GET",
  "path": "/echo",
  "query_params": {
    "user": "test",
    "age": "20"
  },
  "headers": {
    "host": "localhost:8000",
    "user-agent": "curl/7.68.0",
    "accept": "*/*"
  },
  "body": null
}

POST请求测试（JSON体）

bash
curl -X POST "http://localhost:8000/echo" \
  -H "Content-Type: application/json" \
  -d '{"name": "echo", "type": "service"}'

响应示例：

json
{
  "method": "POST",
  "path": "/echo",
  "query_params": {},
  "headers": {
    "host": "localhost:8000",
    "user-agent": "curl/7.68.0",
    "accept": "*/*",
    "content-type": "application/json",
    "content-length": "32"
  },
  "body": {
    "name": "echo",
    "type": "service"
  }
}