api.define

Scaffold Zalando-compliant OpenAPI 3.1 and AsyncAPI 3.0 specifications from enterprise templates.

2|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/epieczko/betty --skill api-define
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api.define
Source: https://github.com/epieczko/betty/tree/main/skills/api.define
Command: npx skills add https://github.com/epieczko/betty --skill api-define

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, context.schema, and includes scripts (resource) components.

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-service API. Instead of manually writing the OpenAPI spec, they use api.define to 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

Frequently Asked Questions about api.define

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

FAQPage Schema
How do I generate OpenAPI specifications that meet enterprise standards?

OpenAPI specification generation automates creation of production-ready API contracts. api.define scaffolds Zalando-compliant OpenAPI 3.1 specs from enterprise templates, embedding RFC 7807 error handling, snake_case naming, JWT security, and X-Flow-ID headers in seconds, eliminating manual inconsistencies.

Can I scaffold AsyncAPI specifications for event-driven services?

Yes. api.define generates AsyncAPI 3.0 specifications alongside OpenAPI contracts. It handles template-driven scaffolding for asynchronous services, applying the same enterprise best practices and naming conventions to event-driven architectures.

What's the fastest way to create multiple API specs without writing them manually?

Template-driven scaffolding accelerates spec creation by applying predefined enterprise patterns. api.define loads YAML/JSON templates, substitutes variables, extracts resource names, applies versioning, and writes output to a configurable directory—turning spec authoring from hours to minutes.

Do I need to understand OpenAPI and AsyncAPI formats to use this?

No prerequisite expertise required. api.define automates the technical details: template selection, variable substitution, and spec generation handle RFC 7807 compliance, security schemes, and metadata. You supply the service name and API type; the Skill produces compliant specs.

How does api.define ensure API specs follow enterprise naming and security conventions?

Enterprise templates embed Zalando guidelines into the generation process. api.define enforces snake_case naming, JWT authentication schemes, RFC 7807 Problem JSON error responses, X-Flow-ID headers, and metadata requirements automatically—ensuring consistency across all scaffolded APIs.

What happens after I generate an API spec—how do I publish or validate it?

api.define writes published API IDs and titles alongside YAML/JSON outputs to your configured directory. Downstream steps integrate with API registries, validation tools, or documentation platforms to version, publish, and monitor the generated specifications.