@html-schema/api-client
v0.1.0
Published
跨端 API 契约与 mock client 包。当前阶段用于把 Web、移动端、桌面端未来会共享的接口形状集中到框架无关包内,并提供无后端环境下可运行的 mock client。
Readme
@html-schema/api-client
跨端 API 契约与 mock client 包。当前阶段用于把 Web、移动端、桌面端未来会共享的接口形状集中到框架无关包内,并提供无后端环境下可运行的 mock client。
能力
- 统一分页类型:
PageRequest、PageResult<T>。 - 统一错误类型:
ApiClientError、createApiError()。 - API 契约:认证、项目、待办、整改、附件、通知、设备注册。
- mock 数据:当前用户、会话、项目、待办、整改、通知。
- mock client:
createMockApiClient()。 - 未实现 HTTP adapter:
createUnimplementedHttpAdapter(),用于显式标记尚未接入真实传输层。
使用
import { createMockApiClient } from "@html-schema/api-client";
const client = createMockApiClient();
const projects = await client.projects.listProjects({ page: 1, pageSize: 10 });边界
- 不依赖 Vue、Element Plus、Pinia、Vite 运行时。
- 不直接绑定 axios;真实 HTTP 传输后续通过 adapter 或上层应用接入。
- mock 数据只用于开发、预览和测试,不代表最终后端字段全集。
命令
pnpm --filter @html-schema/api-client test
pnpm --filter @html-schema/api-client typecheck
pnpm --filter @html-schema/api-client build