majiayu000 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:
- GET /api/articles - Get a list of all articles
- GET /api/articles/:id - Get a single article by ID
Architecture
The API follows Clean Architecture with these layers:
- Domain Layer - Core business logic (entities, repository interfaces)
- Application Layer - Use cases (business logic orchestration)
- Infrastructure Layer - External dependencies (database, repository implementations)
- 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/
Related Skills
- database - Database schemas and table specifications