DOCSPontx Hub
公开文档v1
本页统一 SDK

统一 SDK / 当前语言:TypeScript

TypeScript SDK:统一的命名、类型与调用方式。

了解统一 SDK 当前的 TypeScript 版本:每个 API 使用 @pontx/<api-slug> 包名,并提供生成类型、统一客户端和独立 CLI。

01

统一包契约

包名可预测,类型来自固定的 PontxSpec,发布状态由 Hub 精确验证。

包名@pontx/<api-slug>
运行时Node.js ≥ 18
模块ESM + CommonJS
类型TypeScript declarations
安装
pnpm add @pontx/frankfurter
02

按认证方式选择客户端

所有 SDK 都遵循同一命名与类型契约;具体导出会忠实表达 API 的认证和调用模型。

默认客户端
import currencyExchangeClient from "@pontx/frankfurter";

const result = await currencyExchangeClient.exchangeRates.getLatestRates({
  base: "USD",
  symbols: "JPY,CNY"
});

接口方法按 PontxSpec 显式 tag 与 operationId 生成。以每个 API 的 SDK 页面代码为准,不要假定所有供应商拥有相同认证构造器。

03

独立 API CLI

已发布的 SDK 可以同时暴露 pontx-<api-slug> 命令,直接使用同一份生成类型。

Frankfurter dedicated CLI
pnpm add --global @pontx/frankfurter

pontx-frankfurter call exchangeRates.getLatestRates \
  --base USD \
  --symbols JPY,CNY \
  --dry-run
pontx-hub跨 API 目录

搜索、资源检查、Hub 预演与受控代理调用。

pontx-<api>单个 API

随 SDK 发布,适合本地开发、CI 和 API 专用脚本。

04

版本与发布边界

访客安装已发布版本;Hub 验证,但不会代表访客发布 npm 包。

major

不兼容的 PontxSpec 或生成接口变化

minor

向后兼容的新接口或字段

patch

文档或生成器修复

查看所有已发布 SDK ↗