REST API design patterns
Design consistent REST APIs — resource naming, status codes, pagination, error envelopes, versioning, rate limiting
- What
- Design consistent REST APIs — resource naming, status codes, pagination, error envelopes, versioning, rate limiting
- Cost
- Free
- Needs
- a REST API project (new or existing); nothing else — the skill is guidance plus code patterns, no accounts or keys required
- Install
- Copy the installer prompt below into your Muse — your agent does the rest.
Curated by Skill Harbor — @affaan-m's REST API design playbook: plural, kebab-case resource naming with URL conventions (including what not to do — verbs in URLs, singular nouns, snake_case), HTTP method semantics with an idempotency table, a status-code reference that maps real failures to the right codes (400/401/403/404/409/422/429, never "200 for everything"), standardized success and error response envelopes (data/meta/links, field-level validation details), offset vs cursor pagination with a when-to-use guide, filtering/sorting/search patterns, token-based auth and resource-level vs role-based authorization examples, rate-limit headers and tier design, URL-path versioning strategy (max two active versions, 6-month deprecation with Sunset headers), plus ready-to-adapt implementation patterns in TypeScript (Next.js + Zod), Python (Django REST Framework) and Go (net/http), and a ship-it checklist. MIT-licensed. Skill Harbor never reviews the code, review it yourself before use. Discovered via skills.sh.
Version:
Quick answer
REST API design patterns is a free Muse skill for designing consistent REST APIs: resource naming, status codes, pagination, error envelopes, versioning and rate limiting. It covers plural kebab-case naming, HTTP method semantics with an idempotency table, a status-code reference mapping real failures to the right codes, standardized envelopes, and offset versus cursor pagination.
Install
Copy the install package below, then paste it into Muse🧪 Install ran in our test sandbox · Nov 11, 2026📌 Pinned version: commit 4eb71d9Step 0 — before installing anything: read this install prompt, summarize in a few lines what this build does and what installing it involves, then ask me to confirm before you proceed. Prerequisites: a REST API project (new or existing); nothing else — the skill is guidance plus code patterns, no accounts or keys required Install "REST API design patterns" for me. It teaches an agent @affaan-m's conventions for consistent REST APIs: plural kebab-case resource naming, HTTP method semantics, a status-code reference (no more "200 for everything"), standard success/error envelopes with field-level validation details, offset vs cursor pagination, filtering/sorting/search, token auth and authorization patterns, rate limiting, URL versioning with deprecation strategy, plus implementation patterns in TypeScript, Python and Go and a pre-ship checklist. MIT-licensed. Repository: https://raw.githubusercontent.com/affaan-m/ecc/4eb71d92a39cab44ad40ac9d8a6a5ccb4029d6c2/.agents/skills/api-design/SKILL.md Pinned version: install the code at commit 4eb71d92a39cab44ad40ac9d8a6a5ccb4029d6c2 exactly (Skill Harbor tested this version). Do not substitute a newer version. If this commit is unreachable, stop and tell me. 1. Fetch the SKILL.md file (and any helper files) from the repository path into a temporary folder 2. Safety check: review the SKILL.md and scripts for anything suspicious (unexpected network calls, shell commands, credential harvesting). This repo should contain zero secrets in code, credentials only via the secure vault, allowed hosts declared in the SKILL.md. Verify that holds here; STOP on any red flag and tell me. 3. Install it as a skill: copy SKILL.md and its helper files into the agent's skills directory, in a folder named "api-design". 4. Verify with no network calls: frontmatter valid, files in place. 5. Report what was installed, where, and what I still need to do myself (e.g. nothing — it is a design reference; point the agent at your API when reviewing or designing endpoints). GitHub is optional: if I have a GitHub account or the gh CLI, you may use it; otherwise public access is fine. Never require it unless it's in the prerequisites above. Rules: don't touch anything outside the temp folder and the install target. If anything looks off, stop and ask me.
Saved to your recent installs. Find it anytime on /connect.
🔒 Security, provenance and what this touches
The install prompt below already includes the vetting steps: your agent follows the community checklist before installing anything with executable code. Want more?
Verification certificate
Dated facts about what was checked for this listing, and how. This is not a safety certification.
- Pinned version
- 4eb71d9 · 2026-10-13
- Sandbox install test
- Install ran in our test sandbox · Nov 11, 2026
- Creator identity
- Not verified
- Fingerprint watch
- Last checked · Nov 19, 2026 : no change detected in the files linked by this install prompt
- Install prompt analysis
- 2026-10-13 : No commands, network calls, packages, file writes or API keys detected.
Skill Harbor never reviews the code of a listed skill. These are dated facts about the install prompt and our install test, not a safety certification. Review a skill yourself before you install it. How we verify
Questions
How do I install a skill?
Every product page includes a copy-paste install prompt. Paste it into your Muse and it sets the skill up for you — no manual configuration.
Where does my money go?
Straight to the seller. Skill Harbor never processes payments: checkout happens on the seller’s own page, usually Stripe.
What does the ✓ next to a creator’s name mean?
It means we confirmed the identity of the person behind the listing. It says nothing about the code itself — always check a skill before installing it.