Rest Api Design Advisor
Design scalable REST APIs with OpenAPI 3.0 and Swagger documentation
What You Can Do
You can design complete REST API specifications from requirements, translating them into resource-oriented endpoint architectures that follow industry best practices. Claude generates OpenAPI 3.0 schemas with validated request/response definitions, ensures correct HTTP method semantics and status code usage, and produces Swagger documentation ready for Swagger UI, ReDoc, or Postman integration. Catch design anti-patterns and naming inconsistencies before implementation.
Features
translates requirements into RESTful URL hierarchies and structures
creates complete, valid specifications with request/response models
ensures GET, POST, PUT, PATCH, DELETE usage matches RESTful semantics
applies correct HTTP status codes (200, 201, 400, 401, 403, 404, 422, 500, etc.) to each endpoint
enforces consistent resource names, parameter naming, and URI patterns
produces interactive API documentation for teams and client developers
identifies design violations and suggests corrections before deployment
includes standard patterns for querying collections
Example Output
Example 1: E-commerce Product API Design
Paths:
/products:
GET: List all products with pagination
POST: Create new product (201 Created)
/products/{id}:
GET: Retrieve single product (200 OK)
PUT: Update product (200 OK)
DELETE: Remove product (204 No Content)
Status Codes: 400 Bad Request, 401 Unauthorized, 404 Not Found, 422 Unprocessable Entity
Example 2: User Management API
Endpoint: POST /users
Request: {name, email, role}
Response 201: {id, name, email, role, created_at}
Response 400: {error, field, message}
Response 409: {error: "Email already exists"}
Example 3: OpenAPI 3.0 Specification Generated YAML with complete schemas, security definitions, error responses, and documentation ready for Swagger UI or code generation.
What's Included
- SKILL.md instruction file with REST API design methodology:
- OpenAPI 3.0 template with complete specification structure:
- Endpoint design checklist covering HTTP methods, status codes, and naming conventions:
- Common API patterns for pagination, filtering, sorting, and error handling:
- Swagger documentation template ready for Swagger UI or ReDoc integration:
Who It's For
- Backend Engineers designing new microservices or API endpoints
- API Architects establishing consistent patterns across service ecosystems
- Technical Leads reviewing endpoint design quality and governance
- DevOps/Platform Engineers standardizing API specifications across teams
- Full-Stack Developers building APIs that clients will consume
Best For
- Greenfield API design — architecting new services from requirements
- API refactoring — modernizing legacy endpoints to REST standards
- OpenAPI specification generation — creating formal docs for Swagger UI or code generation
- Team API guidelines — establishing consistent endpoint patterns and naming
- Design review and validation — catching anti-patterns before implementation
You might also like
Rapidly analyze production incidents by correlating observability signals—logs, metrics, traces, and events—to identify the true root cause instead of symptoms. You'll reconstruct incident timelines, quantify impact scope, and generate both immediate remediation steps and long-term prevention measures.
Claude analyzes your code diffs and generates standardized commit messages that follow the Conventional Commits specification. The skill automatically determines the correct commit type, scope, and description based on the changes you've made, ensuring your messages are parseable by automation tools while remaining human-readable for code reviewers.
Query your local Screenpipe instance to retrieve screen recordings, audio transcriptions, UI element accessibility trees, keyboard/mouse input logs, and productivity analytics. You can search by keywords, filter by content type (audio, OCR, accessibility, input), set time ranges, and extract structured data about your applications, meetings, and work sessions without sending data to external servers.
by az9713
You can automate the entire NotebookLM workflow programmatically—create notebooks, add diverse sources (URLs, PDFs, YouTube, audio, video, images), generate all artifact types including audio podcasts and interactive study guides, and download results in multiple formats. This skill unlocks capabilities not available in the web UI, making it ideal for batch processing, content pipelines, and research automation at scale.
by teng-lin
You'll transform high-level feature requirements into a complete development plan covering API design, frontend implementation, testing strategy, and documentation. The skill helps you identify dependencies, parallelize work across frontend and backend teams, and establish quality gates that ensure features ship bug-free with proper error handling and logging.
Transform schema and data changes into production-ready migration packages that protect data integrity and minimize downtime. You can handle column additions, renames, type conversions, and backfills using proven patterns like expand-contract and shadow tables. The skill generates explicit rollback scripts, validation checklists, and phased execution plans that keep applications stable throughout the migration.
You can design end-to-end NGS pipelines tailored to your experiment type (WGS, WES, RNA-seq, targeted), troubleshoot pipeline failures by analyzing QC metrics and logs, and optimize performance by fine-tuning parameters and identifying bottlenecks. This skill handles the full workflow from raw sequencing data quality assessment through variant interpretation and annotation.
You can accelerate your entire antenna design workflow—from initial concept to optimized specifications—by leveraging Claude's knowledge of electromagnetic theory, antenna types, and design trade-offs. Claude helps you parameterize designs, identify optimal configurations for your frequency band and application, and prepare detailed briefs for simulation and manufacturing. You'll generate design reviews, impedance-matching solutions, and validation checklists without context-switching to multiple tools.