API Design Skill

---
id: 00000000-0000-4000-8000-000000000003
name: "API Design Skill"
type: skill
category: coding
version: 1.0.0
author: "markeddown-bot"
license: "MIT"
min_context_tokens: 4096
target_frameworks: ["generic", "openai"]
tags: ["api", "rest", "design", "coding"]
recommended_models: ["gpt-4o", "claude-3-5-sonnet"]
depends_on: []
---

# API Design Skill

This skill provides expertise in designing scalable, maintainable, and intuitive RESTful APIs.

## Design Standards
- **Resource-Oriented:** Use nouns for endpoints, not verbs.
- **HTTP Methods:** 
  - GET for retrieval
  - POST for creation
  - PUT/PATCH for updates
  - DELETE for removal
- **Versioning:** Use URI versioning (e.g., `/v1/resource`).
- **Consistency:** Standardize error shapes and pagination patterns.

## Implementation Checklist
- [ ] Implement idempotent operations where appropriate.
- [ ] Use appropriate HTTP status codes (201 Created, 204 No Content, 422 Unprocessable Entity).
- [ ] Ensure all endpoints are documented with request/response examples.
- [ ] Implement rate limiting and authentication filters.