skills.rest
tipmaster
tipmasterCOMMUNITY
Explore all skills by this author →
GitHub

api-design-review

Validate REST API contracts for methods, status codes, and versioning.

Updated Aug 23, 2026
Search Tags:#versioning#authentication#error handling#api design#rest#developer experience#graphql
One-click install
npx skills add https://github.com/tipmaster/claude-config --skill api-design-review
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-review
Source: https://github.com/tipmaster/claude-config/tree/main/skills/api-design-review
Command: npx skills add https://github.com/tipmaster/claude-config --skill api-design-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill catches critical API design flaws early, preventing costly post-deployment fixes, ensuring client compatibility, and providing a consistent, secure developer experience. It systematically validates API contracts before implementation.

Core Features & Use Cases

  • REST Principles Validation: Ensures correct use of HTTP methods, status codes, and resource naming for RESTful APIs.
  • Versioning Strategy: Guides defining and applying API versioning for smooth evolution and managing breaking changes.
  • Auth & Error Handling: Validates authentication, authorization, and consistent, informative error responses.
  • Use Case: Design a new public REST API for a mobile application, ensuring proper versioning, secure authentication, clear error messages, and efficient pagination for large datasets to provide a great developer experience.

Quick Start

Use the api-design-review skill to evaluate my proposed API endpoint for user management, focusing on REST principles and error handling.