@hd-front-end/jsbridge-sdk 1.0.2 → 1.0.4

package/docs/03-API/344/275/277/347/224/250/346/226/207/346/241/243.md

@@ -0,0 +1,1104 @@
+# JSBridge SDK API 使用文档（生产级 v2）
+
+> **当前版本**：生产级 v2 - 完整 API 文档
+
+## 1. 快速开始
+
+### 1.1 安装
+
+```bash
+npm install @hd-front-end/jsbridge-sdk
+```
+
+### 1.2 初始化
+
+```typescript
+import { init, JSBridge } from '@hd-front-end/jsbridge-sdk'
+
+// 初始化配置
+await init({
+  debug: {
+    enabled: process.env.NODE_ENV === 'development',
+    useVConsole: true
+  },
+  monitor: {
+    enabled: process.env.NODE_ENV === 'production',
+    autoReport: true,
+    reportInterval: 60000,
+    logTag: 'JSBridge-Monitor'
+  }
+})
+
+// 使用 API
+const result = await JSBridge.scan()
+```
+
+## 2. 核心 API
+
+### 2.1 初始化 API
+
+#### init(config?)
+
+初始化 JSBridge SDK。
+
+**参数**：
+
+```typescript
+interface JSBridgeConfig {
+  debug?: {
+    enabled: boolean          // 是否启用 debug
+    useVConsole?: boolean     // 是否启用 vconsole
+    logLevel?: 'debug' | 'info' | 'warn' | 'error'
+    showTimestamp?: boolean   // 显示时间戳
+    showPlatform?: boolean    // 显示平台
+  }
+  monitor?: {
+    enabled: boolean          // 是否启用监控
+    autoReport?: boolean      // 自动上报
+    reportInterval?: number   // 上报间隔（ms）
+    maxCacheSize?: number     // 最大缓存条数
+    logTag?: string           // 日志 TAG
+  }
+}
+```
+
+**返回值**：`Promise<boolean>`
+
+**示例**：
+
+```typescript
+const success = await init({
+  debug: {
+    enabled: true,
+    useVConsole: true,
+    logLevel: 'debug'
+  },
+  monitor: {
+    enabled: true,
+    autoReport: true,
+    reportInterval: 60000,
+    logTag: 'JSBridge-Monitor'
+  }
+})
+
+if (success) {
+  console.log('初始化成功')
+}
+```
+
+#### inApp()
+
+检查是否在原生 App 环境中。
+
+**返回值**：`boolean`
+
+**示例**：
+
+```typescript
+import { inApp } from '@hd-front-end/jsbridge-sdk'
+
+if (inApp()) {
+  // 在原生环境，可以使用 JSBridge API
+} else {
+  // 不在原生环境
+}
+```
+
+#### getPlatform()
+
+获取当前平台。
+
+**返回值**：`Platform` ('android' | 'ios' | 'unknown')
+
+**示例**：
+
+```typescript
+import { getPlatform, Platform } from '@hd-front-end/jsbridge-sdk'
+
+const platform = getPlatform()
+
+if (platform === Platform.Android) {
+  console.log('Android 平台')
+} else if (platform === Platform.iOS) {
+  console.log('iOS 平台')
+}
+```
+
+## 3. 设备能力 API
+
+### 3.1 scan(options?)
+
+调用原生扫码功能。
+
+**参数**：
+
+```typescript
+interface ScanOptions {
+  scanType?: string[]        // 扫码类型：['qrCode', 'barCode']
+  hideAlbum?: boolean        // 是否隐藏相册入口
+  timeoutInterval?: string   // 超时时间（秒）
+}
+```
+
+**返回值**：
+
+```typescript
+interface ScanResult {
+  resp_code: number          // 响应码：1000-成功, 10-取消
+  resp_result: string        // 扫码结果
+  resp_message: string       // 响应消息
+}
+```
+
+**示例**：
+
+```typescript
+import { JSBridge } from '@hd-front-end/jsbridge-sdk'
+
+try {
+  const result = await JSBridge.scan({
+    scanType: ['qrCode'],
+    hideAlbum: true,
+    timeoutInterval: '30'
+  })
+  
+  if (result.resp_code === 1000) {
+    console.log('扫码成功:', result.resp_result)
+  } else if (result.resp_code === 10) {
+    console.log('用户取消')
+  }
+} catch (error) {
+  console.error('扫码失败:', error)
+}
+```
+
+### 3.2 vibrate(duration?)
+
+触发设备振动。
+
+**参数**：
+- `duration` (number, 可选): 振动时长（毫秒），默认 200ms
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+// 振动 200ms
+await JSBridge.vibrate()
+
+// 自定义振动时长
+await JSBridge.vibrate(500)
+```
+
+### 3.3 getDeviceInfo()
+
+获取设备信息。
+
+**返回值**：
+
+```typescript
+interface DeviceInfo {
+  brand: string              // 设备品牌
+  model: string              // 设备型号
+  system: string             // 系统版本
+  platform: string           // 平台
+  // ... 其他设备信息
+}
+```
+
+**示例**：
+
+```typescript
+const deviceInfo = await JSBridge.getDeviceInfo()
+console.log('设备信息:', deviceInfo)
+```
+
+### 3.4 getNetworkType()
+
+获取网络类型。
+
+**返回值**：`Promise<string>` - 'wifi' | '4g' | '3g' | 'none' 等
+
+**示例**：
+
+```typescript
+const networkType = await JSBridge.getNetworkType()
+console.log('网络类型:', networkType)
+```
+
+## 4. 媒体能力 API
+
+### 4.1 chooseMedia(options)
+
+选择图片或视频。
+
+**参数**：
+
+```typescript
+interface MediaOptions {
+  count?: number             // 最多可选数量，默认 9
+  mediaType?: string[]       // 媒体类型：['image', 'video']
+  sourceType?: string[]      // 来源：['album', 'camera']
+  maxDuration?: number       // 视频最大时长（秒）
+  sizeType?: string[]        // 图片质量：['original', 'compressed']
+  camera?: string            // 相机：'back' | 'front'
+}
+```
+
+**返回值**：
+
+```typescript
+interface MediaResult {
+  resp_code: number
+  resp_message: string
+  tempFilePaths: string[]    // 临时文件路径
+  tempFiles: Array<{
+    path: string
+    size: number
+    duration?: number        // 视频时长
+  }>
+}
+```
+
+**示例**：
+
+```typescript
+// 选择图片
+const result = await JSBridge.chooseMedia({
+  count: 1,
+  mediaType: ['image'],
+  sourceType: ['album', 'camera'],
+  sizeType: ['compressed']
+})
+
+console.log('选择的图片:', result.tempFilePaths)
+
+// 选择视频
+const videoResult = await JSBridge.chooseMedia({
+  count: 1,
+  mediaType: ['video'],
+  maxDuration: 60
+})
+```
+
+### 4.2 uploadFile(options)
+
+上传文件。
+
+**参数**：
+
+```typescript
+interface UploadOptions {
+  url: string                // 上传地址
+  filePath: string           // 文件路径
+  name: string               // 文件对应的 key
+  header?: Record<string, string>  // HTTP 请求头
+  formData?: Record<string, any>   // 额外表单数据
+}
+```
+
+**返回值**：
+
+```typescript
+interface UploadResult {
+  resp_code: number
+  resp_message: string
+  statusCode: number         // HTTP 状态码
+  data: string               // 服务器返回数据
+}
+```
+
+**示例**：
+
+```typescript
+const result = await JSBridge.uploadFile({
+  url: 'https://api.example.com/upload',
+  filePath: '/tmp/image.jpg',
+  name: 'file',
+  header: {
+    'Authorization': 'Bearer token'
+  },
+  formData: {
+    userId: '123'
+  }
+})
+
+if (result.resp_code === 1000) {
+  console.log('上传成功:', result.data)
+}
+```
+
+### 4.3 previewImage(options)
+
+预览图片。
+
+**参数**：
+
+```typescript
+interface PreviewOptions {
+  urls: string[]             // 图片 URL 列表
+  current?: number           // 当前显示的索引，默认 0
+}
+```
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.previewImage({
+  urls: [
+    'https://example.com/image1.jpg',
+    'https://example.com/image2.jpg'
+  ],
+  current: 0
+})
+```
+
+### 4.4 getImageInfo(options)
+
+获取图片信息。
+
+**参数**：
+
+```typescript
+interface ImageInfoOptions {
+  src: string                // 图片路径
+}
+```
+
+**返回值**：
+
+```typescript
+interface ImageInfo {
+  width: number              // 图片宽度
+  height: number             // 图片高度
+  path: string               // 图片路径
+  type: string               // 图片类型
+}
+```
+
+**示例**：
+
+```typescript
+const info = await JSBridge.getImageInfo({
+  src: '/tmp/image.jpg'
+})
+
+console.log(`图片尺寸: ${info.width}x${info.height}`)
+```
+
+### 4.5 bluetoothPrint(options)
+
+蓝牙打印。
+
+**参数**：
+
+```typescript
+interface PrintOptions {
+  content: string            // 打印内容
+  // ... 其他打印配置
+}
+```
+
+**返回值**：
+
+```typescript
+interface PrintResult {
+  resp_code: number
+  resp_message: string
+}
+```
+
+**示例**：
+
+```typescript
+const result = await JSBridge.bluetoothPrint({
+  content: '打印内容'
+})
+```
+
+## 5. 路由能力 API
+
+### 5.1 setNavigationBar(options)
+
+设置导航栏。
+
+**参数**：
+
+```typescript
+interface NavBarOptions {
+  title?: string             // 标题
+  frontColor?: string        // 前景色
+  backgroundColor?: string   // 背景色
+}
+```
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.setNavigationBar({
+  title: '商品详情',
+  frontColor: '#ffffff',
+  backgroundColor: '#000000'
+})
+```
+
+### 5.2 closeWebView()
+
+关闭当前 WebView。
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.closeWebView()
+```
+
+### 5.3 onRoute(handler)
+
+注册路由跳转回调。
+
+**参数**：
+- `handler` (Function): 路由回调函数
+
+**示例**：
+
+```typescript
+JSBridge.onRoute((data) => {
+  console.log('原生触发路由跳转:', data)
+  router.push(data.path)
+})
+```
+
+### 5.4 notifyRouteChange(data)
+
+通知原生路由变化。
+
+**参数**：
+- `data` (any): 路由数据
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.notifyRouteChange({
+  path: '/product/detail',
+  query: { id: '123' }
+})
+```
+
+## 6. 存储能力 API
+
+### 6.1 getStorage(key?)
+
+获取存储数据。
+
+**参数**：
+- `key` (string, 可选): 存储的 key
+
+**返回值**：`Promise<any>`
+
+**示例**：
+
+```typescript
+// 获取所有数据
+const allData = await JSBridge.getStorage()
+
+// 获取指定 key 的数据
+const userData = await JSBridge.getStorage('userData')
+```
+
+### 6.2 setStorage(data)
+
+设置存储数据。
+
+**参数**：
+- `data` (any): 要存储的数据
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.setStorage({
+  userData: { name: '张三', age: 20 }
+})
+```
+
+### 6.3 getAppInfo()
+
+获取 App 信息。
+
+**返回值**：`Promise<string>` - JSON 字符串
+
+**示例**：
+
+```typescript
+const appInfoStr = await JSBridge.getAppInfo()
+const appInfo = JSON.parse(appInfoStr)
+console.log('App 信息:', appInfo)
+```
+
+### 6.4 onRefreshStore(handler)
+
+注册刷新 Store 回调。
+
+**参数**：
+- `handler` (Function): 刷新回调函数
+
+**示例**：
+
+```typescript
+JSBridge.onRefreshStore((data) => {
+  console.log('原生触发刷新 Store:', data)
+  store.commit('updateUserInfo', data)
+})
+```
+
+### 6.5 notifyAppOnload(data)
+
+通知原生 App 已加载完成。
+
+**参数**：
+- `data` (any): 加载数据
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.notifyAppOnload({
+  name: 'MyApp',
+  version: '1.0.0'
+})
+```
+
+## 7. 系统能力 API
+
+### 7.1 makePhoneCall(options)
+
+拨打电话。
+
+**参数**：
+
+```typescript
+interface PhoneCallOptions {
+  phoneNumber: string        // 电话号码
+}
+```
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.makePhoneCall({
+  phoneNumber: '10086'
+})
+```
+
+### 7.2 onPdaScan(handler)
+
+注册 PDA 扫码回调。
+
+**参数**：
+- `handler` (Function): 扫码回调函数
+
+**示例**：
+
+```typescript
+JSBridge.onPdaScan((data) => {
+  console.log('PDA 扫码:', data)
+})
+```
+
+## 8. 日志能力 API（新增）
+
+### 8.1 log.debug(message, tag?)
+
+记录 DEBUG 级别日志。
+
+**参数**：
+- `message` (string): 日志内容
+- `tag` (string, 可选): 日志标签
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.log.debug('调试信息', 'Debug')
+await JSBridge.log.debug(`API 响应: ${JSON.stringify(data)}`, 'API')
+```
+
+### 8.2 log.info(message, tag?)
+
+记录 INFO 级别日志。
+
+**参数**：
+- `message` (string): 日志内容
+- `tag` (string, 可选): 日志标签
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.log.info('用户点击了购买按钮', 'UserBehavior')
+await JSBridge.log.info('订单创建成功', 'OrderService')
+await JSBridge.log.info(`页面加载耗时: ${duration}ms`, 'Performance')
+```
+
+### 8.3 log.warn(message, tag?)
+
+记录 WARN 级别日志。
+
+**参数**：
+- `message` (string): 日志内容
+- `tag` (string, 可选): 日志标签
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.log.warn('库存不足', 'Inventory')
+await JSBridge.log.warn('接口响应较慢', 'Performance')
+```
+
+### 8.4 log.error(message, tag?)
+
+记录 ERROR 级别日志。
+
+**参数**：
+- `message` (string): 日志内容
+- `tag` (string, 可选): 日志标签
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await JSBridge.log.error('支付失败', 'Payment')
+await JSBridge.log.error(`订单创建失败: ${error.message}`, 'OrderService')
+```
+
+### 8.5 writeLog(request)
+
+通用日志方法。
+
+**参数**：
+
+```typescript
+enum LogLevel {
+  DEBUG = 'DEBUG',
+  INFO = 'INFO',
+  WARN = 'WARN',
+  ERROR = 'ERROR'
+}
+
+interface LogRequest {
+  tag?: string               // 日志标签
+  level: LogLevel            // 日志级别
+  message: string            // 日志内容
+}
+```
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+import { JSBridge, LogLevel } from '@hd-front-end/jsbridge-sdk'
+
+await JSBridge.writeLog({
+  level: LogLevel.INFO,
+  message: '用户行为日志',
+  tag: 'UserBehavior'
+})
+```
+
+### 8.6 日志使用场景
+
+#### 用户行为日志
+
+```typescript
+// 进入页面
+await JSBridge.log.info('用户进入商品详情页', 'UserBehavior')
+
+// 点击按钮
+await JSBridge.log.info('用户点击加入购物车', 'UserBehavior')
+
+// 完成操作
+await JSBridge.log.info('用户完成支付', 'UserBehavior')
+```
+
+#### 业务错误日志
+
+```typescript
+try {
+  await createOrder()
+} catch (error) {
+  await JSBridge.log.error(
+    `订单创建失败: ${error.message}`,
+    'OrderService'
+  )
+}
+```
+
+#### 性能日志
+
+```typescript
+const startTime = Date.now()
+await loadData()
+const duration = Date.now() - startTime
+
+await JSBridge.log.info(
+  `页面加载耗时: ${duration}ms`,
+  'Performance'
+)
+```
+
+#### API 调用日志
+
+```typescript
+// 请求前
+await JSBridge.log.debug('开始请求商品列表', 'API')
+
+try {
+  const response = await fetch('/api/products')
+  await JSBridge.log.debug(
+    `请求成功: ${response.data.length} 条数据`,
+    'API'
+  )
+} catch (error) {
+  await JSBridge.log.error(
+    `请求失败: ${error.message}`,
+    'API'
+  )
+}
+```
+
+## 9. 监控 API
+
+### 9.1 Monitor.getStats(api?)
+
+获取性能统计。
+
+**参数**：
+- `api` (string, 可选): API 名称，不传则返回所有 API 统计
+
+**返回值**：
+
+```typescript
+interface PerformanceStats {
+  totalCalls: number         // 总调用次数
+  successCalls: number       // 成功次数
+  failedCalls: number        // 失败次数
+  avgDuration: number        // 平均耗时
+  maxDuration: number        // 最大耗时
+  minDuration: number        // 最小耗时
+}
+```
+
+**示例**：
+
+```typescript
+import { Monitor } from '@hd-front-end/jsbridge-sdk'
+
+// 获取单个 API 统计
+const scanStats = Monitor.getStats('scan')
+console.log('扫码统计:', scanStats)
+
+// 获取所有 API 统计
+const allStats = Monitor.getStats()
+allStats.forEach((stats, api) => {
+  console.log(`${api}:`, stats)
+})
+```
+
+### 9.2 Monitor.getRecords(limit?)
+
+获取调用记录。
+
+**参数**：
+- `limit` (number, 可选): 返回记录数量
+
+**返回值**：`ApiCallRecord[]`
+
+**示例**：
+
+```typescript
+// 获取最近 10 条记录
+const records = Monitor.getRecords(10)
+
+records.forEach(record => {
+  const status = record.success ? '✓' : '✗'
+  console.log(`${status} ${record.api}: ${record.duration}ms`)
+})
+```
+
+### 9.3 Monitor.report()
+
+手动上报监控数据（通过 log）。
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await Monitor.report()
+console.log('监控数据已上报')
+```
+
+### 9.4 Monitor.reportError(api, error, detail?)
+
+立即上报错误（通过 log）。
+
+**参数**：
+- `api` (string): API 名称
+- `error` (string): 错误信息
+- `detail` (any, 可选): 错误详情
+
+**返回值**：`Promise<void>`
+
+**示例**：
+
+```typescript
+await Monitor.reportError('scan', '扫码失败', {
+  errorCode: 'E001',
+  detail: '相机权限被拒绝'
+})
+```
+
+### 9.5 Monitor.clear()
+
+清空监控数据。
+
+**返回值**：`void`
+
+**示例**：
+
+```typescript
+Monitor.clear()
+```
+
+## 10. Debug API
+
+### 10.1 Debug.trace(api, params?)
+
+追踪 API 调用。
+
+**参数**：
+- `api` (string): API 名称
+- `params` (any, 可选): API 参数
+
+**返回值**：`void`
+
+**示例**：
+
+```typescript
+import { Debug } from '@hd-front-end/jsbridge-sdk'
+
+Debug.trace('scan', { scanType: ['qrCode'] })
+```
+
+### 10.2 Debug.getLogs(level?, limit?)
+
+获取日志。
+
+**参数**：
+- `level` (string, 可选): 日志级别
+- `limit` (number, 可选): 返回日志数量
+
+**返回值**：`any[]`
+
+**示例**：
+
+```typescript
+// 获取所有错误日志
+const errorLogs = Debug.getLogs('error')
+
+// 获取最近 10 条日志
+const recentLogs = Debug.getLogs(undefined, 10)
+```
+
+### 10.3 Debug.clearLogs()
+
+清空日志。
+
+**返回值**：`void`
+
+**示例**：
+
+```typescript
+Debug.clearLogs()
+```
+
+## 11. 完整示例
+
+### 11.1 App.vue 初始化
+
+```typescript
+import { init, JSBridge, getPlatform } from '@hd-front-end/jsbridge-sdk'
+
+const isDev = process.env.NODE_ENV === 'development'
+
+export default {
+  async onLaunch() {
+    // #ifdef H5-HD
+    // 初始化
+    const success = await init({
+      debug: {
+        enabled: isDev,
+        useVConsole: isDev && /vconsole=true/.test(location.search),
+        logLevel: isDev ? 'debug' : 'error'
+      },
+      monitor: {
+        enabled: !isDev,
+        autoReport: !isDev,
+        reportInterval: 60000,
+        logTag: 'JSBridge-Monitor'
+      }
+    })
+    
+    if (!success) return
+    
+    console.log('平台:', getPlatform())
+    
+    // 记录启动日志
+    await JSBridge.log.info('App 启动成功', 'AppLifeCycle')
+    
+    // 注册原生回调
+    JSBridge.onRoute((data) => this.$Router.replaceAll(data))
+    JSBridge.onRefreshStore((data) => this.refreshStore(data))
+    
+    // 获取初始数据
+    const appInfo = await JSBridge.getAppInfo()
+    this.refreshStore(JSON.parse(appInfo), true)
+    
+    // 通知加载完成
+    await JSBridge.notifyAppOnload({ name: 'MyApp' })
+    // #endif
+  }
+}
+```
+
+### 11.2 业务组件使用
+
+```typescript
+import { JSBridge, inApp } from '@hd-front-end/jsbridge-sdk'
+
+export default {
+  methods: {
+    async handleScan() {
+      if (!inApp()) {
+        uni.showToast({ title: '请在 App 中使用', icon: 'none' })
+        return
+      }
+      
+      // 记录用户行为
+      await JSBridge.log.info('用户点击扫码按钮', 'UserBehavior')
+      
+      try {
+        const result = await JSBridge.scan()
+        
+        if (result.resp_code === 1000) {
+          // 记录成功
+          await JSBridge.log.info(
+            `扫码成功: ${result.resp_result}`,
+            'ScanResult'
+          )
+          
+          uni.showToast({ title: '扫码成功', icon: 'success' })
+        }
+      } catch (error) {
+        // 记录错误
+        await JSBridge.log.error(
+          `扫码失败: ${error.message}`,
+          'ScanError'
+        )
+        
+        uni.showToast({ title: '扫码失败', icon: 'error' })
+      }
+    }
+  }
+}
+```
+
+## 12. 最佳实践
+
+### 12.1 统一错误处理
+
+```typescript
+async function safeCall<T>(
+  apiCall: () => Promise<T>,
+  apiName: string,
+  tag: string
+): Promise<T | null> {
+  try {
+    await JSBridge.log.debug(`开始调用 ${apiName}`, tag)
+    const result = await apiCall()
+    await JSBridge.log.info(`${apiName} 成功`, tag)
+    return result
+  } catch (error) {
+    await JSBridge.log.error(
+      `${apiName} 失败: ${error.message}`,
+      tag
+    )
+    return null
+  }
+}
+
+// 使用
+const result = await safeCall(
+  () => JSBridge.scan(),
+  '扫码',
+  'ScanService'
+)
+```
+
+### 12.2 封装日志工具
+
+```typescript
+export const Logger = {
+  behavior(action: string, detail?: any) {
+    return JSBridge.log.info(
+      `[行为] ${action}${detail ? ': ' + JSON.stringify(detail) : ''}`,
+      'UserBehavior'
+    )
+  },
+  
+  error(module: string, error: string) {
+    return JSBridge.log.error(`[${module}] ${error}`, 'BusinessError')
+  },
+  
+  performance(metric: string, duration: number) {
+    return JSBridge.log.info(`[性能] ${metric}: ${duration}ms`, 'Performance')
+  }
+}
+
+// 使用
+await Logger.behavior('点击购买', { productId: '123' })
+await Logger.error('订单', '创建失败')
+await Logger.performance('页面加载', 1234)
+```
+
+## 13. 文档导航
+
+- **[00-项目概览.md](./00-项目概览.md)** - 项目概述
+- **[01-架构设计.md](./01-架构设计.md)** - 架构设计
+- **[02-技术实现.md](./02-技术实现.md)** - 技术实现
+- **[04-测试方案.md](./04-测试方案.md)** - 测试方案
+- **[05-迁移指南.md](./05-迁移指南.md)** - 迁移指南
+
+---
+
+**完整的 API 文档，包含日志能力** 🎯
+