@longzai-intelligence-transport/http-core
v0.2.0
Published
Downloads
186
Readme
@longzai-intelligence-transport/http-core
HTTP 工具核心模块,提供 API 路由定义、类型推断、响应 Schema、API 函数工厂等共享基础设施。
安装
bun add @longzai-intelligence-transport/http-core功能特性
- 契约类型定义 - 类型安全的 API 契约定义
- 通用 Schema - 基于 Zod 的请求/响应 Schema
- 路由工具 - API 路由定义和路径参数处理
- API 函数工厂 - 创建类型安全的 API 调用函数
- HTTP 客户端 - 基于 Axios 的 REST 客户端实现
依赖
axios- HTTP 客户端zod- Schema 验证(peer dependency)@longzai-intelligence-pagination/core- 分页类型@longzai-intelligence-zod/utils- Zod 工具函数
使用示例
import {
createHttpClient,
createApiFunctions,
defineRoute,
} from '@longzai-intelligence-transport/http-core';
// 定义路由
const routes = {
getUser: defineRoute({
method: 'GET',
path: '/users/:id',
response: UserSchema,
}),
};
// 创建客户端
const client = createHttpClient({
baseURL: 'https://api.example.com',
});
// 创建 API 函数
const api = createApiFunctions(client, routes);导出模块
contract- 契约类型定义schemas- 通用 Schema 定义routes- 路由工具函数factory- API 函数工厂utils- 响应工具类client- HTTP 客户端实现
许可证
UNLICENSED
