@zerolith /客户端
基于中立契约的类型化HTTP客户端。 zerolith-client 读取OpenAPI 3。并编写一个TypeScript模块:每个组件模式一个类型 Api 接口,每个操作有一个条目,以及 routes 客户端运行的表。 createClient 获取该表并检查对它的每个调用:操作名称、它的路径和查询参数、它的主体以及它解析到的内容。
npx zerolith-client openapi.json --out src/api.ts
import { createClient } from "@zerolith/client";
import { type Api, routes } from "./api.ts";
const api = createClient<Api>(routes, { baseUrl: "/api" });
const note = await api.call("getNote", { params: { id } });
const notes = api.query("listNotes", () => ({ query: { q: search.get() } }));
在2xx之外的响应用A拒绝 ProblemError 携带服务器发送的RFC 9457问题,或者从状态行生成的问题。 query 将操作包装在资源中,该资源在其读取的信号发生变化时再次调用。一个自定义 transport 响应处理中的请求、测试请求或电子桥接请求,客户端从不假设哪个服务器生成了文档。
指南在 文档网站.
状态:α。安装与 npm install @zerolith/client@alpha; API可能会在1.0之前更改。
文档
- 这个 输入客户端指南 用作为测试运行的示例解释它。
- 这个 参考 列出从源生成的每个导出。
- 对zerolith不熟悉?这个 教程 一步一步地构建一个应用程序 操场上 在浏览器中运行代码。
许可证
apache - 2.0。看到 LICENSE.
关于 @zerolith/client 的常见问题
@zerolith/client 是什么?
基于中立合约的zerolith类型HTTP客户端:从OpenAPI文档生成路由表和类型,调用带有检查输入的操作,以及读取RFC 9457问题的失败
如何安装 @zerolith/client?
在项目目录运行 npm install @zerolith/client,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zerolith(^0.1.0-alpha.8)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 zerolith-client,可以用 npx zerolith-client 直接运行。
@zerolith/client 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@zerolith/client 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@zerolith/client 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >=24.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@zerolith/client 可以商用吗?
@zerolith/client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。
@zerolith/client 还在维护吗?
最新版本 0.1.0-alpha.8 发布于 2026/11/03(今天);至今共发布 13 个版本,其中过去 12 个月发布了 13 个;首次发布于 2026/10/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。