apifox-integration-manual

API Fox Integration Guidelines

Critical Rules

• All API documentation must be synchronized with API Fox documentation
• API implementation must strictly follow the API Fox documentation specifications
• Response types must be generated based on API Fox documentation examples
• API endpoints must match exactly with the paths defined in API Fox
• Version control of API documentation must be maintained through API Fox
• Use API Fox as the single source of truth for API specifications

File Structure

• Each API module must contain at minimum:
  • hooks.ts: Contains all API hook implementations
  • types.ts: Contains all TypeScript interfaces and types
• Additional files like constants.ts or utils.ts can be added as needed

TypeScript Guidelines

• Maximize type reuse through TypeScript utility types (Pick, Omit, Partial, etc.)
• Use interface composition over repetition
• Common patterns to follow:
  • Request params: interface I{ModuleName}{Action}Params
  • Response types: interface I{ModuleName}{Action}Response
  • List types: type T{Entity}List = Array<T{Entity}>
• Place shared types in a common types.ts file

Response Handling

• API response types must always correspond to the data field of the response
• Generic type parameter in useQuery should match the expected data structure
• Use type assertions sparingly and only when necessary

Examples

// types.ts interface IBaseResponse { code: number; message: string; data: T; }

interface IChatMessage { id: string; content: string; timestamp: number; }

// Reusing types with utility types type TChatMessageList = Array; type TChatMessagePartial = Partial;