liyasthomas/postwoman

Hoppscotch Docker镜像文档

镜像概述和主要用途

Hoppscotch是一个开源API开发生态系统，旨在帮助开发者快速创建和测试API请求，提高开发效率。该镜像提供了完整的Hoppscotch应用程序，支持多种API协议、认证方式、请求管理和团队协作功能，可作为本地或服务器端的API开发工具使用。

核心功能和特性

基础特性

• 轻量高效：极简UI设计，资源占用低，响应速度快
• 多协议支持：
  • HTTP方法：GET、HEAD、POST、PUT、DELETE、CONNECT、OPTIONS、TRACE、PATCH及自定义方法
  • WebSocket：全双工通信通道
  • Server Sent Events：服务器推送更新流
  • Socket.IO：实时双向通信
  • MQTT：主题订阅与发布
  • GraphQL：查询语言支持，含模式获取和多列文档

定制与体验

• 主题定制：支持系统、浅色、深色、黑色主题，可自定义强调色（蓝、绿、青、紫等）
• PWA支持：可安装为渐进式Web应用，支持离线使用、低资源占用、桌面快捷方式
• 国际化：多语言支持，可在界面底部切换语言

请求与响应管理

• 认证方式：支持Basic、Bearer Token、OAuth 2.0、OIDC Access Token/PKCE等
• 请求功能：URL参数管理、请求头配置、请求体设置（支持多种内容类型）、cURL导入、请求代码生成（10+语言/框架）
• 响应处理：实时响应预览、响应头查看、复制/下载响应内容、HTML/图片/JSON/XML预览

高级功能

• 历史记录：请求记录本地/云端同步，一键恢复
• 集合管理：无限层级的请求集合与文件夹，支持导出/导入GitHub Gist
• 环境变量：可定义多环境变量，支持预请求脚本初始化，便于复用和管理
• 代理模式：解决跨域（CORS）问题，支持自定义代理URL，隐藏IP地址
• 脚本支持：预请求脚本（初始化变量、添加时间戳等）和后请求测试（检查状态码、解析响应数据等）
• 团队协作：支持团队集合共享、多成员协作及用户角色管理

使用场景和适用范围

• API开发者：日常接口测试、调试和验证
• 开发团队：协作设计、开发和测试API
• 文档生成：通过集合导出快速创建API文档
• 跨域请求处理：通过代理模式解决本地开发中的CORS问题
• 离线开发：利用PWA特性在无网络环境下继续工作

使用方法和配置说明

Docker快速启动

使用以下命令启动Hoppscotch容器：

bash
docker run --rm --name hoppscotch -p 3000:3000 docker.xuanyuan.run/hoppscotch/hoppscotch:latest

参数说明：

• --rm：容器停止后自动删除
• --name hoppscotch：指定容器名称
• -p 3000:3000：端口映射，将容器的3000端口映射到主机的3000端口
• hoppscotch/hoppscotch:latest：使用最新版本的官方镜像

启动后，访问 http://localhost:3000 即可使用Hoppscotch。

Docker Compose配置

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  hoppscotch:
    image: docker.xuanyuan.run/hoppscotch/hoppscotch:latest
    container_name: hoppscotch
    ports:
      - "3000:3000"
    restart: unless-stopped

使用以下命令启动：

bash
docker-compose up -d

基本使用流程

1. 选择请求方法（如GET、POST等）
2. 输入API URL
3. 配置请求头、参数或请求体（根据需要）
4. 点击"发送"按钮
5. 在响应区域查看结果，可复制、下载或预览响应内容