用途:为 MaintainX 集成开发配置高效的本地开发工作流,支持热重载、模拟服务器与自动化测试。
前提条件:已完成 maintainx-install-auth 设置;安装 Node.js 18+;设置 MAINTAINX_API_KEY 环境变量。
主要能力与用法:
- 初始化 TypeScript 项目:mkdir maintainx-integration && cd maintainx-integration,npm init -y,安装 axios、dotenv 及 dev 依赖 typescript、tsx、vitest、@types/node,并运行 npx tsc --init --target ES2022 --module NodeNext --moduleResolution nodenext --outDir dist。
- 项目结构包含 src/client.ts、work-orders.ts、sync.ts,tests 目录下有模拟单元测试 client.test.ts 与实时集成测试 integration.test.ts,以及 .env、.env.example 等文件。
- 在 package.json 配置脚本:dev 使用 tsx watch 热重载,test 使用 vitest run,test:watch、test:integration(INTEGRATION=true)、build、repl。
- 编写单元测试时用 vi.mock('axios') 模拟 MaintainX API 响应,可测试创建工单和分页获取工单等逻辑。
- 交互式 REPL 通过 npm run repl 启动,全局 client 可直接调用 API,如 await client.getWorkOrders({ limit: 3 })。
- 可选 Docker 开发环境(Dockerfile.dev、docker-compose.dev.yml),并把 ./src 挂载到容器。
适用场景:本地调试 MaintainX API 调用、验证分页与工单逻辑、团队共享开发环境模板。
限制与错误处理:MAINTAINX_API_KEY 未定义时需复制 .env.example;遇到 429 限流应加延迟或用 mock;TypeScript 导入错误需保证 moduleResolution 为 nodenext;tsx 缺失需安装。其余定价、平台等细节暂未提供。