@kdesigner/core

中文文档
0.0.3发布于 2026/11/01MITTypeScriptESM + CJS

KDesigner 网络请求工具库 - 基于 axios 的 HTTP 客户端封装

中文使用文档
文档目录6 节
  1. ✨ 特性
  2. 📦 安装
  3. 🚀 快速开始
  4. 📚 主要模块
  5. 🛠 开发指南
  6. 📝 许可证

@kdesigner/core

License TypeScript Version

KDesigner 网络请求库 - 基于 axios 的 HTTP 客户端封装,面向 AMIS 场景提供 fetcher 适配与业务 API。

✨ 特性

  • 🚀 基于 axios - 稳定可靠的底层请求实现
  • 🔌 AMIS fetcher 适配 - ajaxFetch / fetcherOk / responseOk 等开箱即用的适配层
  • 🧩 业务 API 封装 - 内置 UserApis、PageApis 等常用接口
  • 💾 请求缓存 - withPageCache / withDictCache 提供页面与字典级缓存
  • 🛡️ TypeScript 支持 - 完整的类型定义(FetcherRequest / FetcherResult 等)和类型推导
  • ⚙️ 高度可定制 - 支持拦截器、多实例、取消令牌
  • 🔄 框架无关 - 可以在 Vue / React 等各种框架中使用

📦 安装

pnpm add @kdesigner/core

🚀 快速开始

import { ajaxFetch, UserApis, fetcherOk } from '@kdesigner/core'

// 1. 作为 AMIS fetcher 使用
const result = await ajaxFetch({
  url: '/api/users',
  method: 'get'
})

// 2. 使用内置业务 API
const user = await UserApis.getCurrentUser()

// 3. 构造标准响应
fetcherOk({ status: 0, data: user })

📚 主要模块

模块说明
ajaxaxios 实例、ajaxFetch / ajaxRequest、取消令牌
apiUserApis / PageApis 业务接口,withPageCache / withDictCache 缓存工具
adapterregisterAdapter 等运行时适配注册
graphqlGraphQL 请求支持
loader资源加载器
scope / schema-type作用域与 Schema 类型定义

🛠 开发指南

# 构建
pnpm build

# 测试
pnpm test

# 代码检查
pnpm lint

📝 许可证

MIT

版本与发布记录

@kdesigner/core 共发布 9 个版本,首次发布于 2026/09/29;过去 12 个月发布了 9 个版本。

版本发布日期距今
0.0.3latest2026/11/011 天前
0.0.22026/11/011 天前
0.0.12026/11/011 天前
0.0.02026/11/011 天前
0.0.0-alpha.52026/09/301 个月前
0.0.0-alpha.42026/09/301 个月前

关于 @kdesigner/core 的常见问题

@kdesigner/core 是什么?

KDesigner 网络请求工具库 - 基于 axios 的 HTTP 客户端封装

如何安装 @kdesigner/core?

在项目目录运行 npm install @kdesigner/core,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(>=3.0.0)、vue-router(>=4.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@kdesigner/core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@kdesigner/core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@kdesigner/core 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.0.0 <25.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@kdesigner/core 可以商用吗?

@kdesigner/core 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@kdesigner/core 还在维护吗?

最新版本 0.0.3 发布于 2026/11/01(1 天前);至今共发布 9 个版本,其中过去 12 个月发布了 9 个;首次发布于 2026/09/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。