client-generation_skill

Overview

This skill generates or updates typed API clients from canonical API contracts so consumers call services with validated, type-safe interfaces. It automates deterministic regeneration, keeps clients aligned with contract changes, and minimizes hand-rolled request logic. Outputs can be new client libraries or updated wrapper layers following repo conventions.

How this skill works

The skill locates the canonical contract source and chosen generator/tooling for the target language or framework. It runs deterministic regeneration, updates imports or version pins as required, and optionally commits regenerated artifacts when repository policy allows. After generation it verifies compilation or typechecking of both the generated clients and their consumers to ensure correctness.

When to use it

• When an API contract changes and clients must stay synchronized.
• On CI to regenerate clients for multiple target languages after contract validation.
• When introducing a new target language or framework for API consumption.
• To replace hand-written request logic with type-safe, validated clients.
• Before releasing a version that depends on updated API types or endpoints.

Best practices

• Pin generator and tooling versions or snapshot outputs to ensure deterministic artifacts.
• Store a repo profile describing language targets and repo conventions for consistent output.
• Keep generated code isolated from manual edits; provide wrapper extension points for custom logic.
• Run compile/typecheck in CI and block merges when consumers fail to typecheck.
• Validate the canonical contract before generation and fail fast on contract errors.

Example use cases

• Regenerate Python and TypeScript clients after an OpenAPI contract update and verify consumers compile.
• Add a new language client (e.g., Go) by applying the repo profile and running the generation pipeline.
• Replace brittle hand-rolled HTTP helpers with generated, typed clients to reduce runtime errors.
• Automate client updates in CI so PRs that change contracts include deterministic client artifacts.