Skills
.Work. You
Rest

forge-api-design

Community

Ship backend APIs that clients can trust.

Software Engineering#error handling#api design#rest#typescript patterns#backend verification#cursor pagination#idempotency key
Authorf4rkh4d
Version1.0.0
Installs0

System Documentation

What problem does it solve?

forge-api-design prevents inconsistent, brittle backend API implementations by enforcing durable REST/RPC conventions for resource naming, error responses, pagination, idempotency, status-code decisions, and versioning.

Core Features & Use Cases

  • Opinionated API correctness rules for resource naming, kebab-case paths, stable opaque identifiers, and consistent JSON casing across endpoints.
  • Canonical status-code and error-shape discipline to ensure clients receive predictable HTTP semantics and a uniform { error: { code, message, details?, request_id } } structure without leaking internals.
  • Cursor pagination and mutating idempotency guidance including cursor implementation requirements, safe defaults/caps, and Idempotency-Key handling for payment/order style endpoints.
  • Worked TypeScript examples + verifiers that help detect mistakes around pagination style and canonical error responses.

Quick Start

Use forge-api-design when designing new backend endpoints or auditing existing routes and handlers for REST discipline, canonical errors, cursor pagination, and idempotent mutation behavior.

Dependency Matrix

Required Modules

None required

Components

scriptsassets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: forge-api-design
Download link: https://github.com/f4rkh4d/forge-skill/archive/main.zip#forge-api-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.