This folder contains detailed API specifications and integration guides for backend features.
Each feature document provides:
- Data schemas - The exact data structure the frontend expects
- API endpoints - Complete endpoint specifications with request/response formats
- Pagination & sorting - How data should be ordered and paginated
- Filtering options - Available filters and their behavior
- Error handling - Expected error responses
- Integration notes - Frontend-specific considerations
- FoodItems-Catalog.md - Product listing, details, categories, and search APIs
- RIDER_WALLET_API_DOCUMENTATION.md - Rider wallet balance, transactions, payment details, and withdrawals APIs
- Backend developers should reference these documents when implementing APIs
- Frontend developers can use these as a reference for expected API behavior
- Both teams should update these documents as requirements evolve
Each feature document follows this structure:
- Overview - High-level description
- Data Schema - Expected data structures
- API Endpoints - Detailed endpoint specifications
- Pagination Guidelines - How pagination works
- Display Order Logic - How items should be sorted
- Error Handling - Error response formats
- Additional Considerations - Edge cases and special requirements
- Testing Checklist - What to test
These documents serve as the single source of truth for API contracts between frontend and backend.