@chatbi-v/mocks 2.0.0 → 2.0.3

package/README.md

@@ -1,7 +1,54 @@
-# @chatbi/mocks
+# @chatbi-v/mocks
 
 ChatBI Mock 数据模块，提供灵活的 JSON 和 SSE (Server-Sent Events) 数据模拟功能。
 
+## 模块功能说明
+
+- **响应策略管理**: 支持 JSON、SSE (流式) 和 SSE-Page (分页流) 等多种响应模式。
+- **数据生成器**: 集成 Mock.js，支持丰富的模板语法和动态数据生成。
+- **拦截器适配**: 轻松接入 Axios 或其他请求库，实现无缝的本地模拟开发。
+- **参数动态插值**: 支持在模板中引用请求 Query 或 Body 参数。
+
+## 安装和使用方法
+
+### 安装
+
+```bash
+pnpm add @chatbi-v/mocks
+```
+
+### 使用示例
+
+```typescript
+import { MockInterceptor } from '@chatbi-v/mocks';
+
+const interceptor = new MockInterceptor();
+
+// 注册 mock 规则
+interceptor.register('GET /api/user', {
+  type: 'json',
+  responseSchema: {
+    code: 200,
+    data: { id: 1, name: '@cname' }
+  }
+});
+
+// 在请求库中使用拦截器
+// axios.interceptors.request.use(interceptor.getRequestInterceptor());
+```
+
+## API 文档链接
+
+请参考 [Mock 模块详细文档](https://github.com/your-repo/docs/mocks/index.md)。
+
+## 开发注意事项
+
+- **命名规范**: 建议 Mock 文件以 `.mock.ts` 结尾。
+- **数据一致性**: 确保 Mock 返回的数据结构与后端 API 定义一致。
+- **性能**: SSE 模式下的 `delay` 参数不宜设置过大，以免影响开发体验。
+
+---
+
 ## 特性
 
 - **多种响应策略**：支持 `json` (普通接口)、`sse` (流式接口)、`sse-page` (带分页的流式接口)。