| name | api-contract |
| description | Generate detailed API contracts and specifications including OpenAPI/Swagger definitions, endpoint documentation, and integration guidelines |
| license | MIT |
| compatibility | opencode |
| metadata | [object Object] |
What I do
- Generate complete API specifications using OpenAPI/Swagger standards
- Create detailed endpoint documentation with request/response examples
- Design authentication, authorization, and security protocols
- Define versioning strategies and backward compatibility guidelines
- Provide integration guides and SDK generation specifications
When to use me
Use when you need to:
- Design REST APIs for web or mobile applications
- Create API documentation for external partners or developers
- Define integration contracts between microservices
- Plan API versioning and evolution strategies
- Generate SDK specifications for multiple programming languages
How I work
- API Analysis - Extract API requirements from technical design documents
- Endpoint Design - Define RESTful endpoints with proper HTTP methods
- Schema Definition - Create request/response data models and validation rules
- Authentication Design - Plan security protocols, tokens, and permissions
- Documentation Generation - Create comprehensive API documentation
- Integration Planning - Design webhooks, callbacks, and event flows
- Versioning Strategy - Plan API evolution and backward compatibility
- Testing Specification - Define contract testing and validation approaches
What I need
- Technical design document with system architecture
- Data models and business logic specifications
- Security and authentication requirements
- Integration requirements with external systems
- Performance and scalability requirements
What I produce
A complete API contract package containing:
- OpenAPI Specification - Complete OpenAPI 3.0+ specification file
- Endpoint Documentation - Detailed documentation for each API endpoint
- Data Schemas - Request/response models with validation rules
- Authentication Guide - Security protocols, token management, and permissions
- Integration Guide - How to integrate with the API and handle errors
- Versioning Plan - API evolution strategy and compatibility guidelines
- Rate Limiting - Usage limits and throttling policies
- Webhook Specifications - Event-driven integrations and callback definitions
- SDK Generation Specs - Specifications for generating client libraries
- Testing Guidelines - Contract testing, integration testing, and validation approaches
- Monitoring & Analytics - API usage tracking, performance monitoring, and logging
Usage Example
"Generate API contracts for an e-commerce platform with user management and product catalog"
This will create a complete API specification that backend teams can implement and frontend/external teams can integrate with, including comprehensive documentation and testing guidelines.