skills.rest
tanjed
tanjedCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-contract

Generate RESTful API endpoint definitions, schemas, and error codes from resource descriptions.

1|Updated Apr 12, 2026
Search Tags:#api design#endpoint design#api contract#schema definition#restful services
One-click install
npx skills add https://github.com/tanjed/claude-workflow --skill api-contract-tanjed
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract
Source: https://github.com/tanjed/claude-workflow/tree/main/skills/api-contract
Command: npx skills add https://github.com/tanjed/claude-workflow --skill api-contract-tanjed

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the design of REST API contracts, streamlining the process for creating production-ready API specifications.

Core Features & Use Cases

  • Automated API Contract Creation: Designs complete API contracts based on user input.
  • Endpoint Design: Defines endpoints with authentication, descriptions, request/response schemas, and error codes.
  • Schema Definition: Writes clear schemas for request and response bodies.
  • Error Code Management: Lists domain-specific error codes with HTTP status and descriptions.
  • Use Case: Ideal for software engineers and product managers who need to quickly draft API specifications for new features or services.

Quick Start

Use the api-contract skill to design the API contract for a new resource 'orders'.

Frequently Asked Questions about api-contract

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a RESTful API contract from a resource description?▼

You can generate a RESTful API contract by providing a resource description to the api-contract Skill, which automatically parses the input and produces endpoint definitions, request/response schemas, and error codes.

What is included in an automated API endpoint design?▼

Automated API endpoint design includes endpoint paths, authentication methods, descriptions, request and response body schemas, and domain-specific error codes mapped to HTTP statuses.

Can I use Python to define schemas and error codes for RESTful services?▼

Yes, the Skill utilizes Python for parsing resource descriptions and generating schema definitions and domain-specific error codes for RESTful services.

Is automated API contract generation suitable for product management workflows?▼

Yes, automated API contract generation is intended for both software engineering and product management workflows to quickly draft production-ready API specifications for new features.

What's the best way to draft API specifications for new services?▼

The best way to draft API specifications is to automate the design of RESTful API contracts, allowing you to generate complete endpoint definitions and schemas based on simple resource descriptions.

Do I need to manually define HTTP error codes when designing API schemas?▼

No, you do not need to manually define HTTP error codes; the Skill lists domain-specific error codes with HTTP status descriptions automatically as part of the API contract generation.

Related Skills

Explore More Software Engineering Skills→
mpadmarajmpadmaraj
2

api-design

Define REST API contracts with endpoints, HTTP methods, schemas, and error handling.

Community
Basic
Arnutt-NArnutt-N

API Documentation

Generate OpenAPI/Swagger specs and JSDoc-style annotations for Node.js/Express APIs.

Community
Intermediate
dotlab-hqdotlab-hq
1

s3-openai

Generate OpenAPI 2.0 and 3.0 definitions for an Amazon S3 proxy service.

Official
Advanced
kernex-devkernex-dev
1

backend-architect

Design backend APIs, data models, and service architectures with endpoint contracts and auth rules.

Official
Advanced