darklynx/request-baskets

Request Baskets

概述

Request Baskets是一个用于收集任意HTTP请求的Web服务，用户可通过RESTful API或简单的Web界面检查这些请求。该服务的设计灵感主要来源于RequestHub项目，并重现了RequestBin服务提供的功能。

演示服务器：[***]

核心功能与特性

Request Baskets的主要特性包括：

• 提供RESTful API用于管理和配置请求篮子，可通过交互式API文档查看详情
• 所有篮子均受唯一令牌保护，防止未授权访问；但收集请求的端点无需授权
• 每个篮子可单独配置容量
• 支持分页检索集合（篮子名称、收集的请求）
• 可针对每种HTTP方法配置响应
• 多种存储类型可选，用于存储配置的篮子和收集的请求：
  • 内存存储：超快速，但受可用RAM限制，服务重启后数据丢失
  • Bolt DB：基于嵌入式bbolt数据库的持久化存储，服务重启后数据不丢失，存储不受RAM限制
  • SQL数据库：支持PostgreSQL和MySQL，可实现多服务实例共享数据存储，提高可靠性和可扩展性
  • 可通过自定义存储接口实现扩展

使用场景

适用于以下场景：

• 测试webhook的请求发送情况
• 调试REST API客户端的请求格式
• 验证通知服务发送的HTTP请求
• 收集和分析第三方服务的回调请求
• 开发和测试过程中需要捕获HTTP请求的场景

安装与运行

Docker运行

直接拉取并运行官方镜像：

bash
$ docker pull darklynx/request-baskets
$ docker run -p 55555:55555 darklynx/request-baskets

配置说明

Request Baskets支持多种命令行配置参数，使用-h或--help查看帮助信息。

参数说明

以下是主要命令行参数及对应的Docker环境变量：

使用方法

基本使用

1. 访问Web界面：打开http://localhost:55555
2. 创建篮子：若服务模式为public，可直接创建新篮子；若为restricted，需提供主令牌
3. 收集请求：向http://localhost:55555/<篮子名称>发送HTTP请求（支持GET、POST、PUT、DELETE等方法）
4. 查看请求：
   • 通过Web界面：http://localhost:55555/web/<篮子名称>
   • 通过API：http://localhost:55555/baskets/<篮子名称>

创建篮子成功后，系统会显示授权令牌，需妥善保存，该令牌用于访问篮子的管理功能和检索收集的请求。浏览器会话中会临时存储令牌，但关闭标签页后将丢失。

存储类型配置

Bolt数据库

使用Bolt数据库实现持久化存储，服务重启后数据不丢失：

bash
$ request-baskets -db bolt -file /var/lib/request-baskets/baskets.db

Docker运行示例：

bash
$ docker run -d -p 55555:55555 -v /var/lib/request-baskets:/data \
    -e DB=bolt -e FILE=/data/baskets.db --name rbaskets darklynx/request-baskets

PostgreSQL数据库

使用PostgreSQL作为共享存储：

bash
$ request-baskets -db sql -conn "postgres://rbaskets:pwd@localhost/baskets?sslmode=disable"

使用Docker快速启动PostgreSQL测试环境：

bash
$ docker run --rm --name pg_baskets -e POSTGRES_USER=rbaskets -e POSTGRES_PASSWORD=pwd \
    -e POSTGRES_DB=baskets -d -p 5432:5432 postgres

MySQL数据库

使用MySQL或MariaDB作为共享存储：

bash
$ request-baskets -db sql -conn "mysql://rbaskets:pwd@/baskets"

使用Docker快速启动MySQL测试环境：

bash
$ docker run --rm --name mysql_baskets -e MYSQL_USER=rbaskets -e MYSQL_PASSWORD=pwd \
    -e MYSQL_DATABASE=baskets -e MYSQL_RANDOM_ROOT_PASSWORD=yes -d -p 3306:3306 mysql

Docker相关操作

构建Docker镜像

bash
$ docker build -t request-baskets .

采用多阶段构建，最终镜像大小约12MB，无需本地安装Go SDK。

作为服务运行容器

bash
$ docker run --name rbaskets -d -p 55555:55555 request-baskets
$ docker logs rbaskets  # 查看日志，获取主令牌等信息

清理

停止并删除容器：

bash
$ docker stop rbaskets
$ docker rm rbaskets

删除镜像：

bash
$ docker rmi request-baskets