Index of every page on this site: llms.txt
All skills
jeremylongshore avatar

/generating-api-sdks

@820dfc8
Run it yourself

Generate client SDKs in multiple languages from OpenAPI specifications. Use when generating client libraries for API consumption. Trigger with phrases like "generate SDK", "create client library", or "build API SDK".

Use this Skill: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/generating-api-sdks

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈59 tokens for metadata: the name and description. ≈1.2k when used: this file. ≈2.4k more on demand in 3 files.

Description uses 3.0% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈238 characters, or 3.0%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Generating API SDKs

Overview

Generate type-safe client SDKs in multiple languages (TypeScript, Python, Go, Java) from OpenAPI 3.0+ specifications. Produce idiomatic client libraries with authentication handling, automatic retries, pagination helpers, and comprehensive type definitions that mirror the API contract.

Prerequisites

  • OpenAPI 3.0+ specification file (YAML or JSON) with complete schema definitions
  • Target language toolchain installed (Node.js/TypeScript, Python 3.10+, Go 1.21+, or Java 17+)
  • OpenAPI Generator CLI or equivalent code generation tool
  • Package registry credentials for publishing (npm, PyPI, Maven Central, pkg.go.dev)
  • CI pipeline for automated SDK builds on spec changes

Instructions

  1. Read and validate the OpenAPI specification using Read, checking for complete schema definitions, proper $ref usage, and response type coverage across all endpoints.
  2. Extract all operation IDs, request/response models, and authentication schemes from the specification to build the SDK method inventory.
  3. Generate typed model classes for every schema component, including nested objects, enums, and discriminated unions with proper nullability annotations.
  4. Create a client class with methods for each API operation, mapping operation IDs to idiomatic method names (e.g., listUsers, get_user, CreateUser).
  5. Implement authentication handling with support for Bearer tokens, API keys (header and query), and OAuth2 client credentials flow, configurable at client instantiation.
  6. Add automatic retry logic with exponential backoff for 429 and 5xx responses, with configurable max retries and backoff multiplier.
  7. Build pagination helpers that abstract cursor-based and offset pagination into iterator/generator patterns native to each target language.
  8. Generate comprehensive JSDoc/docstring/Javadoc comments from OpenAPI description and summary fields for full IDE IntelliSense support.
  9. Create a test suite that validates SDK methods against a mock server running the OpenAPI spec, covering authentication, error handling, and pagination.

See references/implementation.md for the full implementation guide.

Output

  • ${CLAUDE_SKILL_DIR}/sdk/typescript/src/client.ts - Main SDK client class with typed methods
  • ${CLAUDE_SKILL_DIR}/sdk/typescript/src/models/ - TypeScript interfaces and type definitions
  • ${CLAUDE_SKILL_DIR}/sdk/python/client.py - Python SDK with dataclass models and async support
  • ${CLAUDE_SKILL_DIR}/sdk/go/client.go - Go SDK with struct types and context-based methods
  • ${CLAUDE_SKILL_DIR}/sdk/*/README.md - Per-language installation and usage documentation
  • ${CLAUDE_SKILL_DIR}/sdk/*/tests/ - SDK test suites per language

Error Handling

Error Cause Solution
Schema generation failure OpenAPI spec contains $ref cycles or missing component definitions Run spec linting with spectral first; resolve circular references with allOf composition
Type mismatch API response does not match generated model types at runtime Add runtime response validation option; log schema drift warnings for API provider notification
Auth configuration error SDK instantiated without required credentials for protected endpoints Throw descriptive error at client construction time listing required auth parameters
Pagination exhaustion Iterator consumes all pages without termination condition Enforce maximum page count safety limit; detect empty result sets as termination signal
Rate limit handling SDK retry logic conflicts with application-level retry logic Expose retryConfig option to disable built-in retries; emit retry events for observability

Refer to references/errors.md for comprehensive error patterns.

Examples

TypeScript SDK for payment API: Generate a fully typed PaymentsClient with methods like createCharge(amount, currency) returning Promise<Charge>, automatic Bearer token injection, and paginated listTransactions() returning an async iterator.

Python SDK with async support: Produce both sync (PaymentsClient) and async (AsyncPaymentsClient) clients using httpx, with Pydantic models for request/response validation and __aiter__ pagination support.

Multi-language CI pipeline: On OpenAPI spec change, automatically regenerate SDKs in all target languages, run tests against a mock server, bump semantic versions, and publish to respective package registries.

See references/examples.md for additional examples.

Resources

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill generates client SDKs from OpenAPI specifications. It involves downloading standard generation tools and executing tests on generated code. Users should ensure that OpenAPI specifications provided to the skill are from trusted sources, as malicious content in the specification could influence the agent's behavior.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

Signed by skilld at 820dfc8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 20 hours ago.

Activeupdated last month
What it can do
Reads files Edits files Runs commands
version
1.23.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
tags
[
  "api",
  "api-sdks"
]
All 6 allowed tools
ReadWriteEditGrepGlobBash(api:sdk-*)
Other metadata
compatibility
Designed for Claude Code

README badge

README badge for jeremylongshore/tons-of-skills-marketplace/generating-api-sdks