Automated summary
Helps design clean, consistent REST or GraphQL APIs, from resource modeling through to an OpenAPI 3.0 specification.
Strengths
- Covers the full flow: resource naming, request/response schemas, errors, pagination and filtering
- Produces a usable OpenAPI 3.0 specification
- Includes guidance on authentication and rate limiting strategies
Limitations
- Does not validate the generated spec against a linter or real tooling
- Stays high-level on GraphQL: no detailed schema, resolver or subscription design
- Auth and rate limiting are only suggested, not implemented
Use it when starting a new API or when you want to formalize and document existing endpoints.
Avoid it if you need working server code generated or a deep security audit of a live production API.
Security analysis
SafeThe skill is a purely advisory instruction file for designing REST/GraphQL APIs. It declares no tools, contains no code, no shell commands, no network calls, and no credential or file access. All steps (resource naming, OpenAPI generation, auth strategy suggestions) are documentation-level guidance with no execution risk.
No concerns found
How this analysis is madeExamples
Design a REST API for a task management app with projects, tasks and comments. Give me resource URLs, request/response schemas, error formats and an OpenAPI 3.0 spec.Refactor these endpoints to add consistent pagination, filtering and sorting patterns, and update the OpenAPI spec accordingly.Here is my domain model for an e-commerce catalog. Should I expose it as REST or GraphQL, and what would the API surface look like?API Design Assistant
Help design clean, consistent APIs following REST or GraphQL best practices.
When to Use
- Designing a new API from scratch
- Refactoring existing API endpoints
- Need OpenAPI/Swagger documentation
Instructions
- Analyze the domain model and resources
- Suggest RESTful resource naming and URL patterns
- Design request/response schemas
- Generate OpenAPI 3.0 specification
- Add pagination, filtering, and sorting patterns
- Include error response formats
- Suggest authentication and rate limiting strategies
From the file to a first result
The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.
No external provenance is recorded: only the copy on this page is available.
This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.
1. Download the file
Download SKILL.mdFrom the root of a test project, save the file as .skill-downloads/api-design-assistant-9321cf/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.
Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.
mkdir -p '.skill-downloads/api-design-assistant-9321cf' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/api-design-assistant-9321cf/download' --output '.skill-downloads/api-design-assistant-9321cf/SKILL.md.part' && mv '.skill-downloads/api-design-assistant-9321cf/SKILL.md.part' '.skill-downloads/api-design-assistant-9321cf/SKILL.md'2. Check prerequisites
Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.
No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.
The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.
3. Load the skill
This file does not provide a usable name/description header for this native procedure. It remains available to download and inspect; use the manual method below.
Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.
4. Try a first task
Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:
Read .skill-downloads/api-design-assistant-9321cf/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.
React Hook Form Best Practices
Development
Master React Hook Form: avoid anti-patterns, manage subscriptions, and handle reset, dirty state, and controlled inputs correctly.
Emotion to Mantine Migration
Development
Migrate Emotion styled-components to Mantine components with style props and CSS modules. Use when converting .styled.tsx files or removing @emotion imports.
Scope Creep Detector
Development
Analyzes git diffs against a stated intent to detect scope creep, unrelated files, broad PRs, and oversized changes, then suggests keep, split, or justify actions.