[JS/TS] 开源API工具Hoppscotch评测：支持GraphQL/WebSocket的Postman替代方案

Hoppscotch 是一个功能强大的开源 API 开发工具生态系统，它致力于让 API 的开发、测试、调试和文档编写变得更加简单高效。凭借其轻量级、跨平台以及丰富的功能特性，它成为了许多开发者处理 API 相关工作时的理想选择。

主要功能亮点

• 开源免费：Hoppscotch 是一个完全开源的项目，代码公开透明，开发者可以自由使用、修改和分发。
• 轻量高效：作为一款轻量级工具，它的资源消耗低，启动和响应速度都非常快。
• 跨平台支持：它提供了 Web 应用、PWA（渐进式 Web 应用）以及桌面客户端，可以在多种平台和设备上访问使用。
• 开箱即用：用户可以直接访问其官网开始使用，无需注册账号即可发送请求和测试 API。当然，注册后可以将测试集合保存到云端，方便在不同设备间同步和管理。

核心应用优势

1. 支持多种 API 协议

• RESTful API：全面支持 GET、POST、PUT、DELETE 等 HTTP 方法，并提供直观的响应查看界面。
• GraphQL：专门提供 GraphQL 查询编辑器，方便发送查询和查看结构化的返回结果。
• WebSocket：支持建立 WebSocket 连接，并进行实时的消息收发测试，这对于测试实时应用非常有用。

2. 环境与变量管理
允许用户创建多个独立的环境（如开发、测试、生产），并在不同环境中配置和使用不同的变量。这极大地方便了在不同场景下进行 API 测试，并支持环境的导入导出，便于团队协作。

3. 脚本编写能力
支持在请求发送前（Pre-request Script）和收到响应后（Post-request Script）执行自定义的 JavaScript 脚本。你可以利用脚本实现复杂的逻辑，例如动态设置请求头、修改请求体内容，或者对响应结果进行自动化验证。

4. 团队协作功能
提供了实时协作能力，允许多个团队成员同时编辑和查看同一个 API 集合。结合 API 集合的导入导出功能，能有效提升团队的开发和测试效率。

5. 自动化测试支持
提供了 CLI（命令行界面）工具，允许你通过命令行自动执行定义好的 API 测试集合，非常适合集成到 CI/CD 流程中，实现自动化测试并生成测试报告。

典型应用场景

• API 开发与调试：在开发过程中快速测试 API 端点，验证其功能是否符合预期，并快速定位问题。
• API 文档编写：Hoppscotch 可以帮助你组织和展示 API 请求，辅助生成清晰易用的 API 使用文档。
• 团队协作开发：团队成员可以共享 API 集合，统一测试用例，确保对接规范一致。

如果你想深入了解其所有功能，查阅详细的 官方文档 是最好的方式。

GitHub 仓库地址
https://github.com/hoppscotch/hoppscotch

桌面客户端下载地址
https://docs.hoppscotch.io/documentation/clients/desktop#download-hoppscotch-desktop-app

如何进行本地部署？

对于希望在内网环境使用或进行二次开发的用户，Hoppscotch 也提供了简单的本地部署方案，这里介绍使用 Docker 的快速部署方法。

1. 安装 Docker
在基于 Debian/Ubuntu 的系统上，可以使用以下命令安装 Docker 和 Docker Compose：

sudo apt update
sudo apt install -y docker.io docker-compose

2. 创建环境配置文件
在部署目录下创建一个名为 .env 的配置文件，用于设置数据库连接、服务端口等关键参数。以下是一个配置示例，你需要根据实际情况修改 DATABASE_URL 等字段：

#-----------------------Backend Config------------------------------#

# Prisma Config
DATABASE_URL=postgresql://username:password@url:5432/dbname # or replace with your database URL

# (Optional) By default, the AIO container (when in subpath access mode) exposes the endpoint on port 80. Use this setting to specify a different port if needed.
HOPP_AIO_ALTERNATE_PORT=80

# Sensitive Data Encryption Key while storing in Database (32 character)
DATA_ENCRYPTION_KEY=********************************

# Whitelisted origins for the Hoppscotch App.
# This list controls which origins can interact with the app through cross-origin comms.
# - localhost ports (3170, 3000, 3100): app, backend, development servers and services
# - app://localhost_3200: Bundle server origin identifier
#   
NOTE: `3200` here refers to the bundle server (port 3200) that provides the bundles,
#   NOT where the app runs. The app itself uses the `app://` protocol with dynamic
#   bundle names like `app://{bundle-name}/`
WHITELISTED_ORIGINS=http://localhost:3170,http://localhost:3000,http://localhost:3100,app://localhost_3200,app://hoppscotch

#-----------------------Frontend Config------------------------------#

# Base URLs
VITE_BASE_URL=http://localhost:3000
VITE_SHORTCODE_BASE_URL=http://localhost:3000
VITE_ADMIN_URL=http://localhost:3100

# Backend URLs
VITE_BACKEND_GQL_URL=http://localhost:3170/graphql
VITE_BACKEND_WS_URL=wss://localhost:3170/graphql
VITE_BACKEND_API_URL=http://localhost:3170/v1

# Terms Of Service And Privacy Policy Links (Optional)
VITE_APP_TOS_LINK=https://docs.hoppscotch.io/support/terms
VITE_APP_PRIVACY_POLICY_LINK=https://docs.hoppscotch.io/support/privacy

# Set to `true` for subpath based access
ENABLE_SUBPATH_BASED_ACCESS=false

3. 启动 Docker 服务
配置完成后，使用一条 Docker 命令即可启动所有服务。该命令会映射前端、后台和管理界面所需的端口，并加载我们刚才创建的 .env 配置文件。

docker run -p 3000:3000 -p 3100:3100 -p 3170:3170 --env-file .env --restart unless-stopped hoppscotch/hoppscotch

启动成功后，你就可以通过浏览器访问 http://localhost:3000 来使用本地部署的 Hoppscotch 了。

官方部署文档
上述为最基本的 Docker 运行方式，更多构建方案（如使用 Docker Compose、从源码构建等）请参考：
https://docs.hoppscotch.io/documentation/self-host/community-edition/install-and-build

总的来说，Hoppscotch 作为一款功能全面且开源免费的 API 工具，无论是用于日常开发调试，还是作为团队内部的协作平台，亦或是集成到自动化流程中，都展现出了强大的实力。其活跃的 开源 社区和持续迭代也保证了工具的活力。如果你正在寻找 Postman 的替代品，或者希望拥有一款可以自主掌控的 API 工具，不妨试试 Hoppscotch。你可以在 云栈社区 找到更多关于 API 开发和 DevOps 工具的深度讨论与资源分享。