OpenParable
Skip to content
← Back to skills

Generating API Contracts

Documents
generating-api-contracts

Generating API Contracts is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/data/generating-api-contracts/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/generating-api-contracts, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Generating Api Contracts

Overview

This skill provides automated assistance for api contract generator tasks. This skill provides automated assistance for the described functionality.

Prerequisites

Before using this skill, ensure you have:

  • API design specifications or requirements documented
  • Development environment with necessary frameworks installed
  • Database or backend services accessible for integration
  • Authentication and authorization strategies defined
  • Testing tools and environments configured

Instructions

  1. Use Read tool to examine existing API specifications from {baseDir}/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
  6. Generate boilerplate code using Bash(api:contract-*) with framework scaffolding
  7. Implement endpoint handlers with business logic
  8. Add input validation and schema enforcement
  9. Integrate authentication and authorization middleware
  10. Configure database connections and ORM models
  11. Write integration tests covering all endpoints

See {baseDir}/references/implementation.md for detailed implementation guide.

Output

  • {baseDir}/src/routes/ - Endpoint route definitions
  • {baseDir}/src/controllers/ - Business logic handlers
  • {baseDir}/src/models/ - Data models and schemas
  • {baseDir}/src/middleware/ - Authentication, validation, logging
  • {baseDir}/src/config/ - Configuration and environment variables
  • OpenAPI 3.0 specification with complete endpoint definitions

Error Handling

See {baseDir}/references/errors.md for comprehensive error handling.

Examples

See {baseDir}/references/examples.md for detailed examples.

Resources

  • Express.js and Fastify for Node.js APIs
  • Flask and FastAPI for Python APIs
  • Spring Boot for Java APIs
  • Gin and Echo for Go APIs
  • OpenAPI Specification 3.0+ for API documentation