ASP.NET Core Web API 测试利器：HttpRepl 工具详解

什么是 HttpRepl

HttpRepl（HTTP 读取-求值-打印循环）是一个轻量级、跨平台的命令行工具，专为测试 Web API 而设计。它支持所有 .NET Core 支持的平台，能够向 ASP.NET Core Web API（以及其他类型的 Web API）发送 HTTP 请求并查看响应结果。

核心功能特性

HttpRepl 支持所有标准 HTTP 方法：

• GET：获取资源
• POST：创建资源
• PUT：更新资源
• DELETE：删除资源
• PATCH：部分更新资源
• HEAD：获取响应头
• OPTIONS：获取支持的HTTP方法

安装指南

安装 HttpRepl 非常简单，只需运行以下命令：

dotnet tool install -g Microsoft.dotnet-httprepl

安装完成后，在 macOS/Linux 上可能需要将工具路径添加到环境变量：

export PATH="$HOME/.dotnet/tools:$PATH"

基本使用方法

启动 HttpRepl

httprepl

查看帮助信息

httprepl -h

连接 Web API

要开始测试 API，首先需要连接到目标服务：

connect https://localhost:5001

OpenAPI 支持

HttpRepl 会自动尝试发现 API 的 OpenAPI 描述文档。如果需要手动指定：

connect https://localhost:5001 --openapi /swagger/v1/swagger.json

API 导航与探索

查看可用端点

ls

示例输出：

.        []
Fruits   [get|post]
People   [get|post]

导航到特定端点

cd people

查看 Swagger UI

ui

请求测试实战

GET 请求测试

获取所有资源：

get

获取特定资源：

get 2

POST 请求测试

post -h Content-Type=application/json

命令会打开默认文本编辑器，编辑请求体后保存即可发送请求。

PUT 请求测试

put 2 -h Content-Type=application/json

DELETE 请求测试

delete 3

高级配置

自定义颜色主题

HttpRepl 支持自定义 JSON 响应输出的颜色：

pref set colors.json White

设置默认文本编辑器

测试需要请求体的方法时，需要配置默认编辑器：

Windows:

pref set editor.command.default "C:\Program Files\Microsoft VS Code\Code.exe"

macOS:

pref set editor.command.default "/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code"

Linux:

pref set editor.command.default "/usr/bin/code"

设置 JSON 缩进

pref set formatting.json.indentSize 4

实用技巧

1. 使用 Tab 键自动补全命令和端点路径
2. 在命令后添加 --verbose 参数获取详细输出
3. 使用 set header 命令设置全局请求头
4. 通过 echo on 命令查看实际发送的请求

总结

HttpRepl 是 ASP.NET Core 开发者的强大工具，它提供了：

• 直观的 API 浏览和测试功能
• 完整的 HTTP 方法支持
• 高度可定制的交互体验
• 跨平台兼容性

无论是本地开发还是测试生产环境 API，HttpRepl 都能显著提升工作效率。通过本文介绍的功能和技巧，开发者可以更高效地进行 API 测试和调试工作。