mirror of https://github.com/CherryHQ/cherry-studio.git synced 2026-01-12 00:49:14 +08:00

History

fullex 81bb8e7981 feat: implement new pagination types and enhance API documentation - Introduced `OffsetPaginationParams`, `CursorPaginationParams`, and their corresponding response types to standardize pagination handling across the API. - Updated existing API types and hooks to support both offset and cursor-based pagination, improving data fetching capabilities. - Enhanced documentation with detailed usage examples for pagination, including request parameters and response structures, to aid developers in implementing pagination effectively. - Refactored related components to utilize the new pagination types, ensuring consistency and clarity in data management.		2026-01-04 21:12:41 +08:00
..
schemas	feat: implement new pagination types and enhance API documentation	2026-01-04 21:12:41 +08:00
apiErrors.ts	feat(api): implement message branching API with tree structure support	2025-12-28 12:54:06 +08:00
apiPaths.ts	refactor(dataApi): streamline Data API schema and type definitions	2025-12-26 12:52:32 +08:00
apiTypes.ts	feat: implement new pagination types and enhance API documentation	2026-01-04 21:12:41 +08:00
index.ts	feat: implement new pagination types and enhance API documentation	2026-01-04 21:12:41 +08:00
README.md	docs(data): update README and remove outdated API design guidelines	2025-12-29 17:15:06 +08:00

README.md

Data API Type System

This directory contains type definitions for the DataApi system.

Documentation

DataApi Overview: docs/en/references/data/data-api-overview.md
API Types: api-types.md
API Design Guidelines: api-design-guidelines.md

Directory Structure

packages/shared/data/api/
├── index.ts           # Barrel exports
├── apiTypes.ts        # Core request/response types
├── apiPaths.ts        # Path template utilities
├── apiErrors.ts       # Error handling
└── schemas/
    ├── index.ts       # Schema composition
    └── *.ts           # Domain-specific schemas

Quick Reference

Import Conventions

// Infrastructure types (via barrel)
import type { DataRequest, DataResponse, ApiClient } from '@shared/data/api'
import { ErrorCode, DataApiError, DataApiErrorFactory } from '@shared/data/api'

// Domain DTOs (directly from schema files)
import type { Topic, CreateTopicDto } from '@shared/data/api/schemas/topic'
import type { Message, CreateMessageDto } from '@shared/data/api/schemas/message'

Adding New Schemas

Create schema file in schemas/ (e.g., topic.ts)
Register in schemas/index.ts using intersection type
Implement handlers in src/main/data/api/handlers/