Skip to content

介绍

@hfyidu/api合肥壹读文化传媒有限公司内部团队维护的 uni-app 业务后台 HTTPS API 封装工具包,面向公司内部多个基于 uni-app 开发的业务项目(H5 / 微信小程序 / App),提供统一、类型安全、开箱即用的后台接口调用层。

解决什么问题

在多个 uni-app 业务项目并行开发的场景下,直接手写 uni.request 调用后台接口容易带来几个问题:

  • 重复造轮子:每个项目都要重新实现请求签名、Token 自动续期、错误处理、Toast 提示等基础设施
  • 类型缺失:接口参数和返回值没有类型约束,联调时全靠口口相传的接口文档,容易出现字段拼写错误、类型不一致
  • 代码组织混乱:接口调用散落在各个页面/组件里,业务逻辑和请求逻辑耦合,难以复用和测试
  • 小程序包体积压力:微信小程序对分包体积有硬性限制,如果直接引入一个"大而全"的 SDK,很容易超出限制

@hfyidu/api 通过 DDD(领域驱动设计)分层 + TypeScript 全量类型 + 按需 subpath 引入的方式,统一解决以上问题。

核心特性

  • DDD 分层架构Domain → AggregateRoot → UseCase → Repository → DTO 职责清晰,详见 DDD 架构设计
  • 9 大业务领域:广告、意见反馈、首页、短剧、小说、订单支付、推广、应用配置、用户体系,详见各业务领域文档
  • 完整类型推断:请求参数、响应 DTO、业务枚举全部类型化
  • 统一请求核心:内置签名算法、Token 自动续期、并发请求排队重试
  • 按需引入@hfyidu/api/<domain> subpath 引入,未使用的领域不会被打进产物,对小程序分包体积友好
  • 生产级构建:Rollup 多入口 + esbuild 压缩 + javascript-obfuscator 混淆,不发布 sourcemap

适用场景

  • 公司内部所有基于 uni-app 开发、且后台接口协议一致的业务项目
  • 需要在 H5、微信小程序、App 等多端复用同一套接口调用逻辑的场景
  • 对微信小程序分包体积有严格要求、需要按业务领域拆分引入的场景

下一步

内部工具包 · 未开源授权,仅限公司内部授权团队使用