27 个版本 (6 个稳定版)
1.3.1 | 2024年6月2日 |
---|---|
1.1.0 | 2024年4月27日 |
1.0.1 | 2024年3月9日 |
0.8.0 | 2023年8月12日 |
0.7.0 | 2023年7月29日 |
#734 in 命令行工具
每月下载量132
120KB
3K SLoC
quartz
构建和测试 HTTP 请求的命令行工具。
关于
quartz 允许开发者创建一个 API 组织项目,该项目可用于通过终端共享、记录和发送请求。
quartz 是什么
- 一个针对喜欢在终端中工作的开发者测试和记录 HTTP 请求的工具。
- Postman 和 Insomnia 等 API 客户端的命令行替代品。
Quartz 不是什么
- cURL 的替代品。
安装
Bash (Linux)
bash -c "$(curl -fsSL https://raw.githubusercontent.com/EduardoRodriguesF/quartz/master/install.sh)"
Homebrew (MacOS)
brew tap eduardorodriguesf/quartz
brew install quartz
Cargo
警告:此方法不推荐,因为它缺少 man 页面。请优先考虑上面的其他安装选项。
cargo install quartz-cli
用法
要创建一个新项目,运行
$ quartz init .
现在开始使用 create
命令创建请求
$ quartz create users/find --url https://api.example.com/users/{{id}}
$ quartz create users/update -X PATCH --url https://api.example.com/users/{{id}} --json '{"name": "John Doe"}'
$ quartz create users/create -X POST --url https://api.example.com/users/{{id}} --json '{"email": "[email protected]", "name": "John Doe"}'
这些命令创建四个 句柄。句柄类似于端点的路径,它们由斜杠 (/) 分隔。我们可以使用 ls
命令查看所有句柄。
$ quartz ls
--- users
GET users/:id
PATCH users/update
POST users/create
注意,users
没有任何方法。这是因为它是一个空句柄,而其他句柄都是确定的端点,我们可以向其发送请求。
要发送请求,请确保您已使用 use
命令使用它
$ quartz use users/find
现在您可以使用 send
命令发送请求。由于我们在 URL 中也定义了一个变量 id
,因此我们需要为此变量提供一个值。
$ quartz send --var id=123
这会输出响应体,但您也可以使用 last
命令查看更多详细信息,该命令会保存我们的最新请求和响应以便我们可以在本地获取数据。
$ quartz last res head
您甚至可以输出 cURL 命令来复制请求
$ quartz show snippet --var id=123 curl
curl -L 'https://api.example.com/users/123' -X GET
现在您已经了解了 quartz 的基础知识,您就可以开始创建更多请求并在项目中组织它们。有关石英的更多信息和高阶用法,请参阅 文档。
文档
要开始使用quartz,请前往安装,并访问man quartz
手册页!
如果遇到任何问题,您也可以在这里阅读markdown版本这里。
许可证
本项目采用Apache License 2.0。
依赖项
~10–25MB
~383K SLoC