context-api-contracts

stars-end 的头像作者 stars-end

4. 前后端API契约、路由、客户端和类型定义。处理API端点定义、请求/响应类型、路由配置和跨栈集成。在处理API端点、请求/响应类型、路由定义或前后端集成时使用,或当用户提及API设计、添加端点、类型不匹配、API契约、REST端点、客户端集成、"404 Not Found"错误、API调用中的"Type error"或路由配置问题时使用。

📖 中文导读:4. 前后端API契约、路由、客户端和类型定义。处理API端点定义、请求/响应类型、路由配置和跨栈集成。在处理API端点、请求/响应类型、路由定义或前后端集成时使用,或当用户提及API设计、添加端点、类型不匹配、API契约、REST端点、客户端集成、"404 Not Found"错误、API调用中的"Type error"或路由配置问题时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: context-api-contracts description: | Frontend-backend API contracts, routes, clients, and type definitions. Handles API endpoint definitions, request/response types, route configuration, and cross-stack integration. Use when working with API endpoints, request/response types, route definitions, or frontend-backend integration, or when user mentions API design, adding endpoints, type mismatches, API contracts, REST endpoints, client integration, "404 Not Found" errors, "Type error" in API calls, or route configuration issues. tags: [api, contracts, integration, cross-stack]

API Contracts

Navigate frontend-backend API integration, routes, clients, and data flow.

Overview

API contracts define frontend ↔ backend communication. Critical for cross-stack changes.

Backend API Routes

  • backend/api/*.py - API v1 endpoints
  • backend/api/v2/*.py - API v2 endpoints
  • backend/api/analytics_api.py
  • backend/api/brokerage_connections.py
  • backend/api/accounts.py
  • backend/api/securities.py

Frontend API Clients

  • frontend/src/services/analyticsApi.ts
  • frontend/src/services/researchApi.ts
  • frontend/src/lib/apiClient.ts - Base API client

TypeScript Contracts

  • supabase/types/database.types.ts - Database types
  • frontend/src/types/**/*.ts - Frontend types

Backend Middleware

  • backend/middleware/*.py - Auth, CORS, etc.

Tests

  • backend/tests/integration/ - API integration tests
  • frontend/e2e/ - E2E API tests

Documentation

  • Internal: docs/backend/API_CONTRACTS.md (create if needed)
  • See context-clerk-integration for auth middleware
  • See context-testing-infrastructure for API test patterns