dunglas/vulcain

HTTP/2 Server Push REST API 镜像文档

镜像概述和主要用途

本Docker镜像基于HTTP/2 Server Push技术构建，旨在帮助开发者快速创建高性能、符合行业习惯的客户端驱动REST API。通过利用HTTP/2协议的服务器推送特性，该镜像能够主动向客户端推送所需资源，减少网络往返次数，显著提升API响应速度和客户端体验。

核心功能和特性

• HTTP/2 Server Push支持：原生集成HTTP/2协议，实现服务器主动推送资源，减少客户端请求延迟
• 客户端驱动架构：采用客户端主导的交互模式，API行为可根据客户端需求动态调整
• 性能优化：通过连接复用、头部压缩和资源预推送，降低API响应时间，提升吞吐量
• REST规范兼容：遵循RESTful API设计原则，支持标准HTTP方法（GET/POST/PUT/DELETE等）
• 轻量级部署：基于精简基础镜像构建，容器启动快速，资源占用低

使用场景和适用范围

• 低延迟API需求场景：如实时数据展示、***交易系统、物联网设备数据采集等对响应速度敏感的应用
• 高并发客户端请求场景：当客户端需要频繁请求关联资源时，通过服务器推送减少请求次数
• 现代Web应用后端：为单页应用（SPA）、移动应用提供高效数据接口
• API网关前置层：作为现有API服务的前置优化层，为客户端推送常用资源

使用方法和配置说明

基本使用（Docker Run）

bash
docker run -d -p 8080:8080 --name http2-push-api [镜像名称]

自定义配置示例

通过环境变量调整API行为：

bash
docker run -d \
  -p 8080:8080 \
  -e PORT=8080 \
  -e API_PREFIX=/api/v1 \
  -e PUSH_THRESHOLD=500ms \
  --name http2-push-api [镜像名称]

Docker Compose配置示例

yaml
version: '3'
services:
  api-service:
    image: [镜像名称]
    ports:
      - "8080:8080"
    environment:
      - PORT=8080
      - API_PREFIX=/api
      - LOG_LEVEL=info
    restart: unless-stopped

配置参数说明

扩展说明

该镜像支持通过挂载自定义配置文件进一步调整行为，配置文件路径为/app/config.yaml，可通过-v /本地配置路径:/app/config.yaml实现自定义配置。详细配置项可参考镜像内置的默认配置文件注释。