api-endpoint-design
CommunityDesign, test, and debug REST APIs with confidence.
Authoralongor666
Version1.0.0
Installs0
System Documentation
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'.
Dependency Matrix
Required Modules
Flaskpytest
Components
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: api-endpoint-design Download link: https://github.com/alongor666/daylyreport/archive/main.zip#api-endpoint-design Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.