Hurl项目中的hurlfmt工具使用指南

Hurl项目中的hurlfmt工具使用指南

hurl Hurl, run and test HTTP requests with plain text. 项目地址: https://gitcode.com/gh_mirrors/hu/hurl

什么是hurlfmt

hurlfmt是Hurl项目提供的一个命令行工具，专门用于格式化Hurl文件以及在不同格式之间进行转换。Hurl本身是一个用于运行HTTP请求的测试工具，而hurlfmt则是对Hurl文件进行美化和转换的辅助工具。

基本使用方法

hurlfmt的基本语法非常简单：

hurlfmt [选项] [文件...]

如果不指定文件，hurlfmt会从标准输入读取内容。默认情况下，hurlfmt会输出格式化并着色后的Hurl文件内容。

核心功能详解

1. 格式化Hurl文件

最基本的用法是对Hurl文件进行格式化：

hurlfmt hello.hurl

这会输出一个格式整齐、语法高亮的Hurl文件内容，使原本可能杂乱的文件变得易读。

2. 格式转换

hurlfmt支持将Hurl文件转换为其他格式：

转换为JSON格式

hurlfmt hello.hurl --output json

输出的JSON结构包含了请求和响应的详细信息，便于程序处理或与其他工具集成。

转换为HTML格式

hurlfmt hello.hurl --output html

HTML输出可以用于文档展示，配合--standalone选项可以生成完整的HTML文件。

3. 从curl命令转换

hurlfmt还能将curl命令转换为Hurl格式：

echo "curl http://example.com" | hurlfmt --in curl

这对于将现有的curl命令迁移到Hurl格式非常有用。

实用选项解析

检查模式

--check选项可以检查文件是否已经正确格式化：

hurlfmt --check file.hurl

如果文件格式正确，返回0；否则返回1。

颜色控制

• --color：强制启用彩色输出
• --no-color：禁用彩色输出

输入输出格式控制

• --in：指定输入格式（hurl或curl）
• --out：指定输出格式（hurl、json或html）

文件操作

• --in-place：直接修改原文件
• -o/--output：指定输出文件

使用场景示例

场景1：批量格式化项目中的Hurl文件

find . -name "*.hurl" -exec hurlfmt --in-place {} \;

场景2：将curl命令转换为Hurl并保存

echo "curl -X POST http://api.example.com/users -H 'Content-Type: application/json' -d '{\"name\":\"John\"}'" | hurlfmt --in curl > create_user.hurl

场景3：生成HTML报告

hurlfmt test.hurl --out html --standalone > report.html

注意事项

1. 某些选项不能同时使用，如--check和--output
2. --in-place只能用于文本输出
3. --standalone只能用于HTML输出

总结

hurlfmt作为Hurl项目的配套工具，为Hurl文件提供了强大的格式化和转换能力。无论是简单的美化输出，还是复杂的格式转换，hurlfmt都能胜任。掌握这个工具可以显著提升使用Hurl的效率和体验。

hurl Hurl, run and test HTTP requests with plain text. 项目地址: https://gitcode.com/gh_mirrors/hu/hurl