Skip to content

JPeetz/agent-skills / skills/api-backend/api-design-first

api-design-first

Verified

Use this skill when designing an API or defining an API contract before writing code. Generates OpenAPI 3.1 specifications, enforces REST design best practices, validates endpoints, and handles versioning, pagination, error formatting, authentication patterns, rate limiting, and idempotency. Activates when users say "design an API", "create OpenAPI spec", "REST API design", "API contract", "Swagger/OpenAPI doc", "API versioning", "rate limiting", or "API security". Covers REST, GraphQL schema design, and gRPC proto generation with cross-protocol consistency.

FileKindSize
CHANGELOG.mdmarkdown2.0 KB
LICENSEother12 B
SKILL.mdskill md11.9 KB
evals/evals.jsonconfig2.3 KB
scripts/generate-mock.shexecutablescript622 B
scripts/validate-spec.shexecutablescript816 B

CHANGELOG.md

View on GitHub
# CHANGELOG — api-design-first

## v1.0.0 — 2026-06-04

### Added
- Initial release of API Design-First agent skill
- Design-first workflow: Resource Model → OpenAPI 3.1 Spec → Review → Mock → Implementation → Tests
- Complete OpenAPI 3.1 specification generation with all required sections
- Resource naming conventions (plural nouns, max 2 levels deep)
- REST endpoint patterns: CRUD operations with correct HTTP methods
- RFC 7807 Problem Details error response format
- Complete HTTP status code usage table (200-500)
- Cursor-based pagination (preferred) and offset-based pagination (acceptable)
- URL path API versioning with deprecation headers (Sunset, Deprecation, Link)
- Authentication patterns: Bearer JWT, API Key, OAuth2 (with OpenAPI securitySchemes)
- Tiered rate limiting with standard response headers (RateLimit-*, Retry-After)
- Idempotency key pattern (Idempotency-Key header) for safe retries
- Filtering, sorting, searching, sparse fieldsets, and include patterns
- GraphQL schema design with Relay Cursor Connections
- gRPC proto design with service definitions
- Cross-protocol consistency rules (camelCase, ISO 8601 dates, cursor pagination everywhere)
- Security hardening: input validation, TLS, CORS, CSP, security headers, rate limiting
- API Design Checklist (15 items) for spec review
- 6 eval cases with near-miss negatives
- Helper scripts: validate-spec.sh, generate-mock.sh, generate-sdk.sh
- Reference docs: OpenAPI Best Practices, REST Checklist, RFC Standards

### Why
The ecosystem has API documentation skills and database schema skills, but no
API design-first skill that enforces contract-first development across REST,
GraphQL, and gRPC. This skill fills the gap between "generate API docs from code"
and "design database schema" by providing a complete API architecture workflow
that drives code generation, not documentation retrofitting.

## v1.0.1 — 2026-10-28

### Changed
- Description rewritten to trigger form ("Use this skill when...") per agentskills.io spec (was marketing-style "Design-first API development skill.")
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall