api

Reference for the REST API endpoints, request/response formats, and data models. Use when implementing or debugging API-related features.

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

When & Why to Use This Skill

This Claude skill serves as a comprehensive API reference for the Fox English learning service, providing detailed documentation on REST API endpoints, request/response formats, and data models. It is designed to streamline the development process by offering clear guidance on Clean Architecture implementation, dependency injection, and repository patterns, making it an essential tool for developers building or maintaining API-driven features.

Use Cases

  • Feature Implementation: Use the reference to correctly implement new API-related features by following established request/response formats and data models.
  • Debugging and Troubleshooting: Quickly identify and resolve issues in API communication by verifying endpoint specifications and base URL configurations.
  • Architectural Alignment: Ensure code consistency by referencing the Clean Architecture layers and dependency rules defined in the service specification.
  • Frontend-Backend Integration: Facilitate seamless integration between the frontend and backend by using documented endpoints like article retrieval and management.
nameAPI
descriptionReference for the REST API endpoints, request/response formats, and data models. Use when implementing or debugging API-related features.

API Reference

Complete API specification for the Fox English learning service.

Base URL

  • API Server (Development): http://localhost:3001
  • Frontend (Development): http://localhost:3000
  • API Base Path: /api

Endpoints

Detailed endpoint specifications are available in the docs/ directory:

Architecture

The API follows Clean Architecture with these layers:

  1. Domain Layer - Core business logic (entities, repository interfaces)
  2. Application Layer - Use cases (business logic orchestration)
  3. Infrastructure Layer - External dependencies (database, repository implementations)
  4. Presentation Layer - HTTP interface (controllers, routes, Express app)

Dependency Rule: Inner layers never depend on outer layers. Dependencies point inward.

Key Implementation Details

  • Dependency Injection: All dependencies manually wired in api/src/presentation/routes.ts
  • Repository Pattern: Domain defines interfaces, infrastructure implements them
  • Database: MySQL in production, SQLite in-memory for tests
  • Testing: Integration tests in api/src/__tests__/integration/
  • database - Database schemas and table specifications