🚀 LLM 流式 API 友好的 HttpClient - Fetcher v1.0.0 发布!

🚀 Fetcher

超轻量级 • 模块化 • TypeScript 优先 • 拦截器驱动 • LLM 流式 API 支持

🌟 为什么选择 Fetcher?

Fetcher 不仅仅是一个 HTTP 客户端——它是一个为现代 Web 开发设计的完整生态系统,原生支持 LLM 流式 API。基于原生 Fetch API 构建,Fetcher 提供了类似 Axios 的体验,同时保持极小的体积。

🚀 核心特性

🎯 @ahoo-wang/fetcher - 基础核心

轻量级核心,驱动整个生态系统:

  • ⚡ 超轻量级: 仅 2.7KiB min+gzip - 比大多数替代品更小
  • 🧭 路径和查询参数: 内置支持路径 ({id}) 和查询参数
  • 🔗 拦截器系统: 请求、响应和错误拦截器,支持有序执行的灵活中间件模式
  • ⏱️ 超时控制: 可配置的请求超时和适当的错误处理
  • 🔄 Fetch API 兼容: 完全兼容原生 Fetch API
  • 🛡️ TypeScript 支持: 完整的 TypeScript 定义,实现类型安全开发
  • 🧩 模块化架构: 轻量级核心和可选扩展包
  • 📦 命名 Fetcher 支持: 自动注册和检索 fetcher 实例
  • ⚙️ 默认 Fetcher: 预配置的默认 fetcher 实例,快速上手

🎨 @ahoo-wang/fetcher-decorator - 声明式 API

使用简洁的声明式服务定义转换您的 API 交互:

  • 🎨 清晰的 API 定义: 使用直观的装饰器定义 HTTP 服务
  • 🧭 自动参数绑定: 路径、查询、头部和正文参数自动绑定
  • ⏱️ 可配置超时: 每方法和每类的超时设置
  • 🔗 Fetcher 集成: 与 Fetcher 的命名 fetcher 系统无缝集成
  • ⚡ 自动实现: 方法自动实现 HTTP 调用
  • 📦 元数据系统: 丰富的元数据支持,用于高级自定义

📡 @ahoo-wang/fetcher-eventstream - 实时流和 LLM 支持

为您的实时应用提供 Server-Sent Events 支持,专为大型语言模型流式 API 设计:

  • 📡 事件流转换: 将 text/event-stream 响应转换为 ServerSentEvent 对象的异步生成器
  • 🔌 拦截器集成: 自动为具有 text/event-stream 内容类型的响应添加 eventStream() 方法
  • 📋 SSE 解析: 根据规范解析 Server-Sent Events,包括数据、事件、ID 和重试字段
  • 🔄 流支持: 正确处理分块数据和多行事件
  • 💬 注释处理: 正确忽略注释行(以 : 开头的行),符合 SSE 规范
  • ⚡ 性能优化: 高效解析和流式传输,适用于高性能应用
  • 🤖 LLM 流准备就绪: 原生支持来自流行 LLM API(如 OpenAI GPT、Claude 等)的流式响应

LLM 集成示例

LlmClient 演示了如何创建具有流支持的 LLM API 专用客户端:

import { createLlmFetcher, LlmClient } from './llmClient';

// 使用您的 API 配置初始化 LLM 客户端
const llmFetcher = createLlmFetcher({
  baseURL: 'https://api.openai.com/v1',
  apiKey: process.env.OPENAI_API_KEY || 'your-api-key',
  model: 'gpt-3.5-turbo',
});

const llmClient = new LlmClient();

// 流式聊天完成,逐个令牌输出
async function streamChatExample() {
  const stream = await llmClient.streamChat({
    messages: [
      { role: 'system', content: 'You are a helpful assistant.' },
      { role: 'user', content: 'Explain quantum computing in simple terms.' },
    ],
    stream: true,
  });

  for await (const event of stream) {
    if (event.data) {
      const chunk = event.data;
      const content = chunk.choices[0]?.delta?.content || '';
      process.stdout.write(content); // 实时输出
    }
  }
}

🔐 @ahoo-wang/fetcher-cosec - 企业安全

使用集成认证保护您的应用:

  • 🔐 自动认证: 自动 CoSec 认证头部
  • 📱 设备管理: 使用 localStorage 持久化的设备 ID 管理
  • 🔄 令牌刷新: 基于响应代码 (401) 的自动令牌刷新
  • 🌈 请求跟踪: 用于跟踪的唯一请求 ID 生成
  • 💾 令牌存储: 安全的令牌存储管理

📦 包生态系统

描述 版本 大小
@ahoo-wang/fetcher 核心 HTTP 客户端
具有 Axios 类似 API 的超轻量级基础
npm size
@ahoo-wang/fetcher-decorator 装饰器支持
声明式 API 服务定义
npm size
@ahoo-wang/fetcher-eventstream 实时流和 LLM 支持
Server-Sent Events (SSE) 支持,原生 LLM 流式 API 集成
npm size
@ahoo-wang/fetcher-cosec 企业安全
CoSec 认证集成
npm size

🚀 快速开始

📦 安装

# 安装核心包
npm install @ahoo-wang/fetcher

# 或安装所有扩展,包括 LLM 流支持
npm install @ahoo-wang/fetcher @ahoo-wang/fetcher-decorator @ahoo-wang/fetcher-eventstream @ahoo-wang/fetcher-cosec

# 使用 pnpm (推荐)
pnpm add @ahoo-wang/fetcher

# 使用 yarn
yarn add @ahoo-wang/fetcher

⚡ 快速示例

基础 HTTP 客户端

import { Fetcher } from '@ahoo-wang/fetcher';

// 创建 fetcher 实例
const fetcher = new Fetcher({
  baseURL: 'https://api.example.com',
  timeout: 5000,
});

// 带路径和查询参数的 GET 请求
const response = await fetcher.get('/users/{id}', {
  urlParams: {
    path: { id: 123 },
    query: { include: 'profile' },
  },
});
const userData = await response.json<User>();

// 自动 JSON 转换的 POST 请求
const createUserResponse = await fetcher.post('/users', {
  body: { name: 'John Doe', email: 'john@example.com' },
});

声明式 API 服务

import { NamedFetcher } from '@ahoo-wang/fetcher';
import {
  api,
  get,
  post,
  path,
  query,
  body,
} from '@ahoo-wang/fetcher-decorator';

// 注册命名 fetcher
const apiFetcher = new NamedFetcher('api', {
  baseURL: 'https://api.example.com',
});

// 使用装饰器定义服务
@api('/users', { fetcher: 'api' })
class UserService {
  @get('/')
  getUsers(@query('limit') limit?: number): Promise<User[]> {
    throw new Error('Auto-generated');
  }

  @post('/')
  createUser(@body() user: User): Promise<User> {
    throw new Error('Auto-generated');
  }

  @get('/{id}')
  getUser(@path('id') id: number): Promise<User> {
    throw new Error('Auto-generated');
  }
}

// 使用服务
const userService = new UserService();
const users = await userService.getUsers(10);

强大的拦截器

import { Fetcher } from '@ahoo-wang/fetcher';

const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });

// 添加带排序的请求拦截器
fetcher.interceptors.request.use({
  name: 'auth-interceptor',
  order: 100,
  intercept(exchange) {
    exchange.request.headers.Authorization = 'Bearer ' + getAuthToken();
  },
});

// 添加响应拦截器用于日志记录
fetcher.interceptors.response.use({
  name: 'logging-interceptor',
  order: 10,
  intercept(exchange) {
    console.log('Response:', exchange.response.status);
  },
});

实时流和 LLM 支持

import { Fetcher } from '@ahoo-wang/fetcher';
import { EventStreamInterceptor } from '@ahoo-wang/fetcher-eventstream';

const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
fetcher.interceptors.response.use(new EventStreamInterceptor());

// 流式实时事件 (通用 SSE)
const response = await fetcher.get('/events');
if (response.eventStream) {
  for await (const event of response.eventStream()) {
    console.log('Real-time event:', event);
  }
}

// 流式 LLM 响应,逐个令牌输出
const llmResponse = await fetcher.post('/chat/completions', {
  body: {
    model: 'gpt-3.5-turbo',
    messages: [{ role: 'user', content: 'Hello!' }],
    stream: true,
  },
});

if (llmResponse.jsonEventStream) {
  // 专门用于 LLM API 的 JSON SSE 事件
  for await (const event of llmResponse.jsonEventStream<ChatCompletionChunk>()) {
    const content = event.data.choices[0]?.delta?.content || '';
    process.stdout.write(content); // 实时令牌输出
  }
}

⚡ 快速示例

基础 HTTP 客户端

import { Fetcher } from '@ahoo-wang/fetcher';

// 创建 fetcher 实例
const fetcher = new Fetcher({
  baseURL: 'https://api.example.com',
  timeout: 5000,
});

// 带路径和查询参数的 GET 请求
const response = await fetcher.get('/users/{id}', {
  urlParams: {
    path: { id: 123 },
    query: { include: 'profile' },
  },
});
const userData = await response.json<User>();

// 自动 JSON 转换的 POST 请求
const createUserResponse = await fetcher.post('/users', {
  body: { name: 'John Doe', email: 'john@example.com' },
});

声明式 API 服务

import { NamedFetcher } from '@ahoo-wang/fetcher';
import {
  api,
  get,
  post,
  path,
  query,
  body,
} from '@ahoo-wang/fetcher-decorator';

// 注册命名 fetcher
const apiFetcher = new NamedFetcher('api', {
  baseURL: 'https://api.example.com',
});

// 使用装饰器定义服务
@api('/users', { fetcher: 'api' })
class UserService {
  @get('/')
  getUsers(@query('limit') limit?: number): Promise<User[]> {
    throw new Error('Auto-generated');
  }

  @post('/')
  createUser(@body() user: User): Promise<User> {
    throw new Error('Auto-generated');
  }

  @get('/{id}')
  getUser(@path('id') id: number): Promise<User> {
    throw new Error('Auto-generated');
  }
}

// 使用服务
const userService = new UserService();
const users = await userService.getUsers(10);

强大的拦截器

import { Fetcher } from '@ahoo-wang/fetcher';

const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });

// 添加带排序的请求拦截器
fetcher.interceptors.request.use({
  name: 'auth-interceptor',
  order: 100,
  intercept(exchange) {
    exchange.request.headers.Authorization = 'Bearer ' + getAuthToken();
  },
});

// 添加响应拦截器用于日志记录
fetcher.interceptors.response.use({
  name: 'logging-interceptor',
  order: 10,
  intercept(exchange) {
    console.log('Response:', exchange.response.status);
  },
});

实时流和 LLM 支持

import { Fetcher } from '@ahoo-wang/fetcher';
import { EventStreamInterceptor } from '@ahoo-wang/fetcher-eventstream';

const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
fetcher.interceptors.response.use(new EventStreamInterceptor());

// 流式实时事件 (通用 SSE)
const response = await fetcher.get('/events');
if (response.eventStream) {
  for await (const event of response.eventStream()) {
    console.log('Real-time event:', event);
  }
}

// 流式 LLM 响应,逐个令牌输出
const llmResponse = await fetcher.post('/chat/completions', {
  body: {
    model: 'gpt-3.5-turbo',
    messages: [{ role: 'user', content: 'Hello!' }],
    stream: true,
  },
});

if (llmResponse.jsonEventStream) {
  // 专门用于 LLM API 的 JSON SSE 事件
  for await (const event of llmResponse.jsonEventStream<ChatCompletionChunk>()) {
    const content = event.data.choices[0]?.delta?.content || '';
    process.stdout.write(content); // 实时令牌输出
  }
}

🎯 集成测试示例

在我们的 integration-test 目录中探索全面、可用于生产的实现:

🌐 HTTP 操作

  • Typicode API 集成 - 与 JSONPlaceholder API 的完整集成,演示实际使用
  • 参数处理 - 高级路径、查询和正文参数管理
  • 错误处理 - 全面的错误处理模式

🔧 高级模式

  • COSEC 认证 - 具有令牌管理的企业级安全集成
  • 拦截器链 - 具有有序执行的复杂中间件模式
  • 超时策略 - 自适应超时配置

📡 实时特性

  • LLM 流式 API - 原生支持从大型语言模型流式响应
  • Server-Sent Events - 实时通知和更新
  • 流数据 - 具有自动重新连接的连续数据流

🎨 装饰器模式

  • 声明式服务 - 使用 TypeScript 装饰器的清晰、可维护的 API 服务层
  • 元数据扩展 - 用于高级用例的自定义元数据
  • 类型安全 API - 完整的 TypeScript 集成和自动类型推断

🏗️ 开发和贡献

🛠️ 先决条件

  • Node.js >= 16
  • pnpm >= 8

🚀 开发命令

# 安装依赖
pnpm install

# 构建所有包
pnpm build

# 运行单元测试和覆盖率
pnpm test:unit

# 格式化代码
pnpm format

# 清理构建产物
pnpm clean

# 运行集成测试
#pnpm test:it

📦 版本管理

同时更新所有包:

pnpm update-version <new-version>

这会更新单体仓库中所有 package.json 文件的版本字段。

🤝 贡献

欢迎贡献!

  1. Fork 仓库
  2. 创建您的功能分支 (git checkout -b feature/AmazingFeature)
  3. 提交您的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开拉取请求

🧪 质量保证

  • 代码覆盖率: 所有包保持在 95% 以上
  • TypeScript: 启用严格类型检查
  • 代码检查: 使用 Prettier 的 ESLint 保证一致的代码风格
  • 测试: 全面的单元和集成测试

📄 许可证

本项目采用 Apache-2.0 许可证

优秀的个人博客,低调大师

微信关注我们

原文链接:https://www.oschina.net/news/369097/fetcher-1-0-0-released

转载内容版权归作者及来源网站所有!

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

相关文章

发表评论

资源下载

更多资源
优质分享Android(本站安卓app)

优质分享Android(本站安卓app)

近一个月的开发和优化,本站点的第一个app全新上线。该app采用极致压缩,本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Mario,低调大师唯一一个Java游戏作品

Mario,低调大师唯一一个Java游戏作品

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长,特征是大鼻子、头戴帽子、身穿背带裤,还留着胡子。与他的双胞胎兄弟路易基一起,长年担任任天堂的招牌角色。

Oracle Database,又名Oracle RDBMS

Oracle Database,又名Oracle RDBMS

Oracle Database,又名Oracle RDBMS,或简称Oracle。是甲骨文公司的一款关系数据库管理系统。它是在数据库领域一直处于领先地位的产品。可以说Oracle数据库系统是目前世界上流行的关系数据库管理系统,系统可移植性好、使用方便、功能强,适用于各类大、中、小、微机环境。它是一种高效率、可靠性好的、适应高吞吐量的数据库方案。

Apache Tomcat7、8、9(Java Web服务器)

Apache Tomcat7、8、9(Java Web服务器)

Tomcat是Apache 软件基金会(Apache Software Foundation)的Jakarta 项目中的一个核心项目,由Apache、Sun 和其他一些公司及个人共同开发而成。因为Tomcat 技术先进、性能稳定,而且免费,因而深受Java 爱好者的喜爱并得到了部分软件开发商的认可,成为目前比较流行的Web 应用服务器。