convolab/echo

请求响应通用Docker镜像文档

镜像概述

本Docker镜像为通用请求响应工具，设计用于接收并处理各类请求，可根据配置返回相应结果。其轻量级架构确保高效运行，同时提供灵活的配置选项以适应不同的请求处理需求。

核心功能和特性

• 多请求类型支持：兼容HTTP、TCP等多种请求协议，可处理不同网络层的请求
• 灵活响应配置：支持通过环境变量或配置文件自定义响应内容、状态码及格式
• 轻量级设计：基于精简基础镜像构建，镜像体积小，启动速度快
• 易于集成：可无缝对接现有系统，支持Docker Compose编排和Kubernetes部署

使用场景和适用范围

• 开发测试环境：模拟第三方服务接口，用于本地开发和单元测试
• 请求模拟服务：快速搭建临时API服务，返回预设响应数据
• 负载测试辅助：作为后端服务接收测试请求，验证前端或客户端的请求处理逻辑
• 简单代理转发：在无复杂业务逻辑场景下，作为轻量级请求转发节点

使用方法和配置说明

基本使用

通过以下命令启动镜像，默认监听80端口并返回"Hello, World!"响应：

bash
docker run -d -p 8080:80 --name request-responder [镜像名称]:latest

启动后可通过curl http://localhost:8080测试，默认返回Hello, World!。

环境变量配置

可通过环境变量自定义镜像行为，常用配置如下：

自定义响应示例

启动时指定自定义响应内容和状态码：

bash
docker run -d -p 8080:80 \
  -e RESPONSE_CONTENT='{"status":"success","data":"custom response"}' \
  -e RESPONSE_STATUS=201 \
  --name custom-responder [镜像名称]:latest

Docker Compose配置

在docker-compose.yml中集成：

yaml
version: '3'
services:
  request-responder:
    image: [镜像名称]:latest
    ports:
      - "8080:80"
    environment:
      - RESPONSE_CONTENT="Compose response"
      - PORT=80
    restart: always

启动服务：docker-compose up -d

注意事项

• 本镜像主要用于开发测试和简单场景，生产环境使用前需评估性能和安全性需求
• 对于高并发场景，建议结合负载均衡策略使用
• 自定义响应内容较长时，建议通过挂载配置文件实现，避免环境变量长度限制