Does this skill follow specific industry standards?

Yes, it defaults to Zalando-compliant templates which include RFC 7807 error handling, specific metadata (x-api-id), and snake_case naming conventions.

What API specifications are supported by api.define?

api.define supports both OpenAPI 3.1 for RESTful services and AsyncAPI 3.0 for event-driven architectures.

Can I specify a custom output directory for my API files?

Yes, you can use the --output-dir parameter to define a custom path for your generated YAML specifications.

Will the generated specs pass standard validation tests?

The specs are designed to be compatible with tools like api.validate, ensuring they pass strict linting and enterprise compliance checks with zero errors.

How does the skill handle resource paths and naming?

It automatically extracts resource names from your service name. For example, 'user-service' automatically generates '/users' paths with pluralized logic.

Enterprise API Scaffolder

Name: Enterprise API Scaffolder
Author: epieczko

byepieczko

API 开发

Generates enterprise-compliant OpenAPI and AsyncAPI specifications using standardized templates and best practices.

关于

api.define is a powerful tool for API-first development that scaffolds production-ready contracts according to strict organizational standards. It automates the creation of OpenAPI 3.1 and AsyncAPI 3.0 specifications, ensuring that every API includes essential features like RFC 7807 error handling, consistent snake_case naming conventions, and required metadata. By handling the boilerplate of API design—including resource extraction, pluralization, and security scheme configuration—it allows developers to maintain high quality and consistency across microservices while ensuring all generated specs are ready for immediate validation.

主要功能

0 GitHub stars
Pre-configures security schemes like JWT and mandatory tracing headers
Generates Zalando-compliant OpenAPI 3.1 and AsyncAPI 3.0 specifications
Implements RFC 7807 Problem JSON for standardized error reporting
Automatically enforces snake_case and kebab-case naming conventions
Smart resource extraction and pluralization from service names

使用场景

Bootstrapping a new microservice with a validated REST API contract
Defining event-driven architectures with Kafka-ready AsyncAPI definitions
Enforcing consistent API design standards across an entire engineering organization

关于

主要功能

0 GitHub stars
Pre-configures security schemes like JWT and mandatory tracing headers
Generates Zalando-compliant OpenAPI 3.1 and AsyncAPI 3.0 specifications
Implements RFC 7807 Problem JSON for standardized error reporting
Automatically enforces snake_case and kebab-case naming conventions
Smart resource extraction and pluralization from service names

使用场景

Bootstrapping a new microservice with a validated REST API contract
Defining event-driven architectures with Kafka-ready AsyncAPI definitions
Enforcing consistent API design standards across an entire engineering organization