tokuppee15/api-tester

API Tester

这是一个可从浏览器发送HTTP请求（GET / POST / PUT / PATCH / DELETE / HEAD / OPTIONS），并通过SQLite管理响应、执行历史、保存的请求及集合的单容器型API测试工具。

只需执行docker compose up即可启动，无需在主机OS安装PHP、Node.js、Composer等环境。

---

目录

1. 核心功能
2. 运行要求
3. 安装与启动
4. 界面使用方法
5. 数据持久化与备份
6. API端点列表
7. 故障排除

---

1. 核心功能

---

2. 运行要求

• Docker Engine 24及以上
• Docker Compose v2及以上
• 浏览器（推荐Chrome/Edge/Firefox/Safari最新版）

---

3. 安装与启动

使用Docker Hub公开的镜像，无需获取源代码，仅需docker-compose.dist.yml文件即可启动。

3.1 首次启动

bash
# 1. 获取分发用Compose文件
curl -O https://raw.githubusercontent.com/IkkoTokunaga/APIMAN-apitester/main/docker-compose.dist.yml

# 2. 启动（首次会拉取镜像）
docker compose -f docker-compose.dist.yml up -d

# 3. 在浏览器中打开以下地址
#    http://localhost:19876

3.2 更新（替换为新版本）

bash
docker compose -f docker-compose.dist.yml pull
docker compose -f docker-compose.dist.yml up -d

3.3 停止

bash
# 停止（数据保留）
docker compose -f docker-compose.dist.yml down

# 停止并删除卷（数据会被清除）
docker compose -f docker-compose.dist.yml down -v

SQLite数据文件（历史、保存请求）存储在主机./database/目录中，仅执行down时下次启动会自动恢复数据。

3.4 修改端口

若19876端口已被占用，可修改docker-compose.dist.yml中的ports字段，例如改为"29876:80"。

---

4. 界面使用方法

主界面（http://localhost:***%EF%BC%89%E7%94%B1%E5%B7%A6%E4%BE%A7 sidebar（保存请求、集合）和中央请求/响应区域组成。

4.1 发送请求

1. 选择方法（GET/POST/PUT/PATCH/DELETE/HEAD/OPTIONS）。
2. 在URL输入目标端点（例如：https://jsonplaceholder.typicode.com/posts/1）。
3. 按需添加Headers（格式：Key: Value，例如Authorization: Bearer xxxxx或Content-Type: application/json）。
4. POST/PUT/PATCH请求需在Body输入JSON等内容。
5. 点击Send按钮，通过服务器发送请求。
6. 结果会显示在Response区域，包括状态码（彩色标记）、耗时（ms）、响应头部及自动格式化的JSON响应正文。

由于请求从服务器端发送，不受浏览器CORS限制。

4.2 查看/重发历史

• 历史面板显示最近50条执行记录。
• 点击历史记录可将请求内容加载到输入栏。
• 可单独删除或批量删除历史记录。

4.3 保存请求

1. 准备好需保存的请求内容。
2. 点击Save按钮，指定“标题”和“集合（可选）”后保存。
3. 左侧sidebar的保存请求列表中可随时点击加载。

4.4 集合整理

• 集合是用于归类保存请求的文件夹式单位。
• 可按API或项目创建集合。
• 保存请求时指定不存在的集合名会自动创建并关联。

4.5 导入/导出

通过JSON导出或导入保存的请求及集合：

导出：

bash
curl http://localhost:19876/api/saved-requests/export -o saved-requests.json

导入：

bash
curl -X POST http://localhost:19876/api/saved-requests/import \
     -H "Content-Type: application/json" \
     -d @saved-requests.json

JSON格式示例：

json
{
  "items": [
    {
      "title": "获取用户列表",
      "method": "GET",
      "url": "https://example.com/api/users",
      "request_headers": { "Authorization": "Bearer xxx" },
      "request_body": null,
      "content_type": "application/json",
      "collection": "Example API"
    }
  ]
}

collection可为字符串或null，指定不存在的集合名会自动创建。

---

5. 数据持久化与备份

• 所有数据存储在SQLite文件（./database/database.sqlite）中。
• docker-compose.dist.yml已绑定挂载./database目录，容器删除后数据不会丢失。
• 备份只需复制该文件：

  bash
  cp database/database.sqlite database/database.$(date +%Y%m%d).sqlite.bak
  

重置数据：

bash
docker compose -f docker-compose.dist.yml down
rm database/database.sqlite
docker compose -f docker-compose.dist.yml up -d

---

6. API端点列表

以下是UI调用的内部API，可直接用于CLI或其他工具操作。基础URL：http://localhost:19876

6.1 代理/历史

POST /api/proxy请求示例：

json
{
  "method": "POST",
  "url": "https://example.com/api/login",
  "headers": { "Content-Type": "application/json" },
  "body": "{\"email\":\"a@example.com\",\"password\":\"secret\"}"
}

6.2 集合

6.3 保存请求

---

7. 故障排除

---

许可证

本项目采用MIT许可证。Laravel本体许可证请参考[***]