api.define
CommunityScaffold API specs with enterprise best practices.
Authorepieczko
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Manually creating API specifications is time-consuming and prone to inconsistencies, especially when adhering to enterprise guidelines. This Skill automates the generation of production-ready OpenAPI and AsyncAPI specs, embedding best practices like RFC 7807 error handling, correct naming conventions, and required metadata.
Core Features & Use Cases
- Template-Driven Generation: Quickly scaffold OpenAPI 3.1 (Zalando-compliant) and AsyncAPI 3.0 specs from enterprise-compliant templates.
- Automated Best Practices: Includes proper error handling (RFC 7807 Problem JSON), snake_case naming, X-Flow-ID headers, and JWT authentication schemes.
- Use Case: A developer needs to create a new
user-serviceAPI. Instead of manually writing the OpenAPI spec, they useapi.defineto generate a Zalando-compliant spec in seconds, ensuring it meets all enterprise standards from the start.
Quick Start
Generate a Zalando-compliant OpenAPI spec for a user service
python skills/api.define/api_define.py user-service openapi --template=zalando
Dependency Matrix
Required Modules
pyyamlcontext.schema
Components
scripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: api.define Download link: https://github.com/epieczko/betty/archive/main.zip#api-define Please download this .zip file, extract it, and install it in the .claude/skills/ directory.