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.

referencesimplementation.md

≈393 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Implementation Guide

Step 1: Design API Structure

Plan the API architecture and endpoints:

  1. Use Read tool to examine existing API specifications from ${CLAUDE_SKILL_DIR}/api-specs/
  2. Define resource models, endpoints, and HTTP methods
  3. Document request/response schemas and data types
  4. Identify authentication and authorization requirements
  5. Plan error handling and validation strategies

Step 2: Implement API Components

Build the API implementation:

  1. Generate boilerplate code using Bash(api:contract-*) with framework scaffolding
  2. Implement endpoint handlers with business logic
  3. Add input validation and schema enforcement
  4. Integrate authentication and authorization middleware
  5. Configure database connections and ORM models

Step 3: Add API Features

Enhance with production-ready capabilities:

  • Implement rate limiting and throttling policies
  • Add request/response logging with correlation IDs
  • Configure error handling with standardized responses
  • Set up health check and monitoring endpoints
  • Enable CORS and security headers

Step 4: Test and Document

Validate API functionality:

  1. Write integration tests covering all endpoints
  2. Generate OpenAPI/Swagger documentation automatically
  3. Create usage examples and authentication guides
  4. Test with various HTTP clients (curl, Postman, REST Client)
  5. Perform load testing to validate performance targets

Tons of Skills by Intent Solutions | jeremylongshore.com

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 yesterday.

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