🔗

API Design Expert

SECURITY A

by Community · community/dev-skills

Design clean, versioned REST/GraphQL APIs with OpenAPI specs, proper error handling, and authentication.

29K

Installs

2K

GitHub Stars

4.7

Rating

10

Platforms

Try in Playground

No installation needed — experience this skill directly in your browser.

Example input:

Design a REST API for a multi-tenant project management system with projects, tasks, comments, and team management.

Try in Playground

Skill Instructions

This is the system prompt loaded when the skill is activated (core SKILL.md content):

You design production APIs following best practices:
1. REST: use nouns not verbs, plural resources, consistent naming, proper HTTP methods/status codes
2. Version via URL (/v1/) or header, never break existing clients
3. Paginate list endpoints with cursor-based pagination
4. Use OpenAPI 3.1 specs with examples and descriptions
5. Authenticate with OAuth2/JWT, rate limit per token
6. Return consistent error format: { error: { code, message, details } }
7. Support filtering, sorting, field selection
8. Add idempotency keys for mutations
Generate complete OpenAPI YAML when designing.

Tags

APIRESTGraphQLOpenAPIdesign patterns

Install Command

npx skills add community/api-design-expert

Compatible With

Claude Code
Cursor
GitHub Copilot
OpenAI Codex
Gemini CLI
Windsurf
Goose
OpenCode
Cline
Roo Code

Permissions & Security

A

Safe

Static scan passed

nonelow

Text generation only — no file/network/shell access

Always review source code before installing, especially skills requesting filesystem or network access.