Skill

api-conventions

Universal REST API design principles — response envelope, route naming, versioning, pagination, status codes. Applies to any backend language or framework. Load when designing or implementing any API endpoint.

npx claudepluginhub manikumarkv/devrunway-claude-plugin --plugin devrunway

Invocation

How this skill is triggered — by the user, by Claude, or both

Slash command

/devrunway:api-conventions

Not user invocable

Model invocable

Inline context

Default effort

Configuration

Activation paths

src/**/*.controller.*src/**/*.route.*src/**/*.handler.*src/**/routes/**src/**/api/**

Context Preview

The summary Claude sees in its skill listing — used to decide when to auto-load this skill

Full standards in [api-conventions.md](api-conventions.md). Always-on summary:

Supporting Files

api-conventions.eval.yamlapi-conventions.md

SKILL.md

43 lines · ~479 tokens

Similar Skills

using-superpowers

190.5k

Mandates invoking relevant skills via tools before any response in coding sessions. Covers access, priorities, and adaptations for Claude Code, Copilot CLI, Gemini CLI.

3 files

superpowers

Stats

LanguageShell

Stars0

MaintenanceExcellent

Last CommitMay 15, 2026

Actions

View Source View Plugin View on GitHub View README

Help us improve

Share bugs, ideas, or general feedback.

Stats

Actions

Help us improve

Share bugs, ideas, or general feedback.

Full standards in api-conventions.md. Always-on summary:

Response envelope — always consistent:

Success: { "success": true, "data": <resource>, "meta": { "requestId": "...", "timestamp": "..." } }
Success + pagination: add "pagination": { "nextCursor": "...", "total": N, "limit": 20, "hasMore": true }
Error: { "success": false, "error": { "code": "NOT_FOUND", "message": "...", "details": [...] }, "meta": { ... } }

JS implementation shape (always use this):

// Success
res.json({ success: true, data: result });
// Error
res.json({ success: false, error: { code: 'NOT_FOUND', message: '...' } });

Routes:

Prefix and version from day one: /api/v1/
Plural nouns: /orders not /order or /getOrders
Nested for ownership: /users/:userId/orders (max 2 levels deep)
kebab-case path segments: /order-items not /orderItems

HTTP status codes:

200 success · 201 created · 204 deleted (no body)
400 invalid input · 401 not authenticated · 403 not authorised
404 not found · 409 conflict · 422 business rule violated · 500 unexpected

Pagination: prefer cursor-based (?limit=20&cursor=<id>) over offset — offset is inconsistent under concurrent writes

Never: verb routes (/getOrders), unversioned paths (/api/orders), bare arrays at root, 200 for errors

For implementation helpers (response builder functions, validation middleware, framework-specific wiring), see your backend layer skill.