安装

环境要求

• Node.js >= 18
• vue ^3.2.0（作为 peerDependency 由业务项目自身提供，不会被打进 @hfyidu/api 产物）
• 基于 uni-app 的项目（H5 / 微信小程序 / App 均可）

安装依赖

pnpm

pnpm add @hfyidu/api

npm

npm install @hfyidu/api

yarn

yarn add @hfyidu/api

@hfyidu/api 依赖 crypto-js（请求签名用到 MD5 算法），已作为 dependencies 声明，安装时会自动一并安装，无需手动引入。

内部私有依赖说明

@hfyidu/api 在构建阶段已经将公司内部工具包 @shivip/mp-core 和 @shivip/common-util 的代码与类型完整打入产物。业务项目安装 @hfyidu/api 后可以通过独立入口直接使用，无需额外安装这些内部依赖：

import { Future, Option, createSingleton } from '@hfyidu/api/core';

完整清单与示例见 Core 内部开发工具。

验证安装

安装完成后，可以在项目中直接导入验证：

import { version } from '@hfyidu/api';

console.log(version); // 1.0.2

下一步

前往快速开始完成初始化并发起第一个请求。