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 firmware logs and diagnose hardware issues that cause device failures, connectivity problems, and performance degradation. You'll identify root causes from stack traces, crash dumps, and sensor data, then generate specific optimization recommendations. This skill transforms raw device logs into actionable debugging plans that reduce time-to-resolution from hours to minutes.
This skill enables you to automatically audit your websites against compliance standards and detect deviations from expected baselines. You can track regulatory requirements, identify policy violations, and generate compliance reports with actionable remediation steps. Monitor multiple sites simultaneously and maintain detailed audit trails for compliance documentation.
Analyze chemical processes systematically to identify hazards, assess risks, and generate safety recommendations. You can perform HAZOP analyses, evaluate compliance with industry standards, conduct root-cause analysis of incidents, and develop emergency response procedures. The skill guides you through structured safety reviews that reduce the likelihood of accidents and regulatory violations.
When a user uploads a file to Claude, you can intelligently detect its type and read it using the appropriate method. Instead of blindly running cat on binary files or loading massive CSVs into context, this skill routes each file type to the right tool, reading only what's needed to answer the user's question. You'll extract text from PDFs, parse structured data from CSVs and JSON, process images, and decompress archives—all without wasting context or producing garbage output.
by seifbenayed
You'll develop systematic approaches to injectable formulation design, from API selection through sterilization strategy. Claude helps you troubleshoot failed batches by analyzing root causes, recommends regulatory pathways (505(b)(2), ANDA, NDA), and provides science-backed solutions for stability, compatibility, and manufacturability challenges.
You can conduct comprehensive hazard analyses for chemical processes using industry-standard methodologies like HAZOP and LOPA. The skill helps you assess risks quantitatively, identify control gaps, design engineered safeguards, and generate formal documentation for regulatory compliance and process safety management.
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