# API Design Plan

> Planning and designing scalable, secure, and intuitive APIs

- Skill: `dongduong2001/api-design-plan` (Agent Skill)
- Install (CLI): `npx skillmds@latest add dongduong2001/api-design-plan`
- Raw SKILL.md: https://api.skillmd.com/api/skills/dongduong2001/api-design-plan/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: DongDuong2001 (https://skillmd.com/u/dongduong2001)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/dongduong2001/api-design-plan

---


# API Design Skill

This skill is utilized during the PLAN phase when defining the contract between different services or between a client and a backend.

## When to use this skill
- When defining RESTful endpoints, GraphQL schemas, or gRPC definitions.
- When creating API documentation (OpenAPI/Swagger).
- When planning API versioning and deprecation strategies.

## Guidelines
- **Consistency:** Maintain consistent naming conventions (e.g., standardizing on plural nouns for REST collections).
- **Versioning:** Plan for API versioning from Day 1 (e.g., `/v1/users`).
- **Pagination & Filtering:** Design endpoints to handle large datasets natively.
- **Security:** Ensure authentication (OAuth2, JWT) and authorization (RBAC/ABAC) are built into the design.