api-patterns
Use when creating or modifying API endpoints. Provides REST conventions and error handling patterns for this project.
When & Why to Use This Skill
This Claude skill serves as a comprehensive guide for standardizing RESTful API development. It provides predefined endpoint conventions, unified JSON response structures, and robust error-handling patterns to ensure architectural consistency, improve backend reliability, and accelerate the integration process between frontend and backend systems.
Use Cases
- Scenario 1: Developing new CRUD endpoints (Create, Read, Update, Delete) for resources like the Pet Adoption Center to ensure consistent URL naming and method usage.
- Scenario 2: Implementing a standardized JSON response format across all API services to simplify data parsing for frontend developers and external consumers.
- Scenario 3: Configuring systematic error handling using appropriate HTTP status codes (e.g., 400, 404, 500) to improve debugging efficiency and API resilience.
- Scenario 4: Refactoring existing legacy API endpoints to align with modern RESTful best practices and project-specific architectural requirements.
| name | api-patterns |
|---|---|
| description | Use when creating or modifying API endpoints. Provides REST conventions and error handling patterns for this project. |
API Patterns for Pet Adoption Center
Endpoint Conventions
- GET /pets - List all pets
- GET /pets/{id} - Get single pet
- POST /pets - Create pet
- PUT /pets/{id} - Update pet
- DELETE /pets/{id} - Delete pet
Response Format
Always return JSON with this structure:
{
"success": True,
"data": {...},
"error": None
}
Error Handling
Use HTTP status codes:
- 200: Success
- 201: Created
- 400: Bad request
- 404: Not found
- 500: Server error
Example Endpoint
@app.route('/pets', methods=['GET'])
def list_pets():
try:
pets = Pet.query.all()
return jsonify(success=True, data=[p.to_dict() for p in pets])
except Exception as e:
return jsonify(success=False, error=str(e)), 500