What problem does it solve?
This Skill provides a comprehensive guide for designing, testing, and troubleshooting REST API endpoints for a vehicle insurance data platform. It ensures consistent, robust, and well-documented API interactions, reducing development time and integration errors.
Core Features & Use Cases
- Endpoint Catalog: Details 11 core endpoints, including KPI data, week comparison, and staff performance distribution.
- Unified Response Format: Standardizes success/failure responses with clear HTTP status codes and error messages.
- Parameter Validation: Specifies validation rules for filters, dates, metrics, and periods, ensuring data integrity.
- Testing & Debugging: Offers cURL examples for quick testing and outlines unit testing best practices with
pytest.
- Use Case: A developer needs to add a new API endpoint to retrieve insurance policy distribution by renewal type. This skill provides the exact structure, parameter validation, and testing methods to implement it correctly and efficiently.
Quick Start
Design a new API endpoint '/api/policy-distribution' that accepts 'date' and 'filters' parameters, and returns policy distribution by 'renewal_type'.