Skip to content

CLI 客户端#

拥有一个用于 API 的终端或命令行客户端非常有用，这样您就可以测试它并了解其工作原理。

虽然 Huma 不内置此功能，但您可以使用 Restish 快速启动并运行 CLI。Restish 通过为每个操作提供命令、将输入转换为命令行参数和选项，并生成有用的帮助文档，为您的 API 提供比直接使用 curl 或 httpie 更高级的接口。

安装 Restish#

首先，安装 Restish：

使用 Homebrew、Go 或 下载发布版 安装。

Terminal
# Homebrew
$ brew tap danielgtaylor/restish
$ brew install restish

# Go (requires Go 1.18+)
$ go install github.com/danielgtaylor/restish@latest

使用 Go、Linux 版 Homebrew 或 下载发布版 安装。

Terminal
# Go (requires Go 1.18+)
$ go install github.com/danielgtaylor/restish@latest

# Homebrew for Linux
$ brew tap danielgtaylor/restish
$ brew install restish

使用 Go 或 下载发布版 安装。

Terminal
# Go (requires Go 1.18+)
$ go install github.com/danielgtaylor/restish@latest

另外，考虑为 Restish 设置 shell 命令行补全。

配置您的 API#

接下来，我们需要将您的 API 信息告诉 Restish，并为其指定一个简短名称，我们称之为 tutorial。使用 api configure 命令执行此操作。这只需执行一次。在继续之前，确保您的 API 正在运行并可访问，因为这会从服务中拉取 OpenAPI 规范。

调用 API#

配置完成后，您可以使用从 OpenAPI 操作 ID 生成的高级命令调用 API 操作：

查看帮助命令，如 restish tutorial --help 或 restish tutorial get-greeting --help 以获取更多详细信息。如果您设置了命令行补全，还可以使用 Tab 键查看所有可用命令。

回顾#

恭喜！您刚刚学习了：

  • 如何安装 Restish
  • 如何为您的 API 配置 Restish
  • 如何使用 Restish 调用您的 API
  • 如何向 Restish 传递参数和主体内容

深入了解#

想要了解 Restish 的工作原理和使用方法？接下来查看这些：