# REST API

> Use this skill when designing REST APIs. Provides REST API design patterns including URL structure, multi-tenancy, request/response formats, HTTP methods, authorization, and testing requirements.

- Skill: `tomevault-io/rest-api-5` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/rest-api-5`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/rest-api-5/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/rest-api-5

---


# REST API Design Guidelines

Comprehensive REST API design patterns with focus on multi-tenancy, versioning, and clear API contracts.

## When to Use This Skill

Use this skill when:
- Designing new REST API endpoints
- Structuring URLs with multi-tenancy support
- Defining request/response formats and error handling
- Implementing control-plane vs data-plane separation
- Planning API versioning and deprecation strategies
- Setting up authorization patterns and testing requirements

## Reference Routing Table

| Reference | Read when you need to… |
|-----------|------------------------|
| `url-design.md` | Design URL structure and endpoints — multi-tenancy patterns, control vs data plane separation, naming conventions, versioning |
| `request-response.md` | Define API contracts — HTTP method usage, status codes, request/response structure, error formats, state-changing operations |
| `advanced-patterns.md` | Implement auth/security, performance optimization — migration and deprecation strategies, testing requirements, anti-patterns |

---
> Source: [imarios/open-vibes](https://github.com/imarios/open-vibes) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-15 -->

