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

/generating-api-contracts

@820dfc8
Run it yourself

Generate API contracts and OpenAPI specifications from code or design documents. Use when documenting API contracts and specifications. Trigger with phrases like "generate API contract", "create OpenAPI spec", or "document API contract".

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

Nothing lands on disk. Nothing to clean up.

Fork this Skill

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

SKILL.md

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

Description uses 3.3% 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 ≈264 characters, or 3.3%.

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 Contracts

Overview

Generate OpenAPI 3.0/3.1 specifications and consumer-driven contract tests from existing API implementations, design documents, or database schemas. Produce machine-readable contracts that serve as the single source of truth for code generation, documentation, testing, and gateway configuration, with Pact integration for consumer-driven contract verification.

Prerequisites

  • API implementation with route definitions and handler logic, or design requirements document
  • OpenAPI authoring tool: Swagger Editor, Stoplight Studio, or IDE with OpenAPI extension
  • Consumer-driven contract framework: Pact (polyglot), Spring Cloud Contract (Java), or Dredd (generic)
  • Schema validation tool: Spectral for OpenAPI linting
  • Version control for contract files with diff-based review process

Instructions

  1. Scan existing route handlers and controller files using Grep and Read to extract all endpoint paths, HTTP methods, request parameter names/types, and response body shapes.
  2. Generate OpenAPI 3.0 specification from the extracted data, including info (title, version, description), servers (environment URLs), paths (operations), and components (reusable schemas).
  3. Define request schemas with field-level constraints: type, format, required, minimum/maximum, pattern (regex), enum, and example values for every property.
  4. Document all response status codes per endpoint with separate schemas: 200/201 for success, 400 for validation errors (with field-level error array), 401/403 for auth failures, and 404/500.
  5. Add security scheme definitions (bearerAuth, apiKey, oauth2) and apply them to appropriate operations using the security field.
  6. Create Pact consumer contract tests that capture expected interactions from the API consumer perspective, defining expected request/response pairs per endpoint.
  7. Set up provider verification that replays Pact interactions against the actual API implementation, verifying the provider satisfies all consumer expectations.
  8. Generate contract artifacts: OpenAPI spec file, Postman collection, and consumer contract (Pact JSON), all versioned alongside the API source code.

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

Output

  • ${CLAUDE_SKILL_DIR}/openapi.yaml - Complete OpenAPI 3.0/3.1 specification
  • ${CLAUDE_SKILL_DIR}/contracts/pact/ - Consumer-driven contract definitions (Pact JSON)
  • ${CLAUDE_SKILL_DIR}/contracts/postman/ - Generated Postman collection for API testing
  • ${CLAUDE_SKILL_DIR}/tests/contract/consumer/ - Consumer contract test implementations
  • ${CLAUDE_SKILL_DIR}/tests/contract/provider/ - Provider verification test suite
  • ${CLAUDE_SKILL_DIR}/scripts/generate-contract.sh - Contract generation automation script

Error Handling

Error Cause Solution
Spec-code divergence API implementation changed without updating the OpenAPI spec Add CI check that generates spec from code and diffs against committed spec
Pact verification failure Provider response does not match consumer expectation Review consumer contract for correctness; update provider if contract is valid
Missing operation ID Endpoint has no operationId, preventing code generation Generate deterministic operation IDs from method + path (e.g., getUsers, createUser)
Circular schema reference Components reference each other creating infinite recursion Break cycles with allOf composition or introduce intermediate types
Example/schema mismatch Example values do not validate against their own schema Auto-validate all examples during spec generation; reject mismatched examples

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

Examples

Code-first OpenAPI generation: Scan Express route decorators and Zod validation schemas to auto-generate a complete OpenAPI 3.1 spec with accurate request/response schemas, examples, and descriptions.

Consumer-driven contract testing: Frontend team publishes Pact contracts defining the API interactions they depend on; backend CI verifies every contract on each deployment, preventing breaking changes.

Design-first workflow: Author OpenAPI spec in Stoplight Studio, generate server stubs and client SDKs from the spec, then implement business logic in the stubs -- spec stays as the single source of truth.

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 provides tools and guidance for generating API contracts, OpenAPI specifications, and consumer-driven contract tests using Pact. No malicious patterns, obfuscation, or unauthorized data access were detected during the analysis.

  • 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.26.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
tags
[
  "api",
  "api-contracts"
]
All 6 allowed tools
ReadWriteEditGrepGlobBash(api:contract-*)
Other metadata
compatibility
Designed for Claude Code

README badge

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