skills.rest
fireflyframework
fireflyframeworkOFFICIAL
Explore all skills by this author →
WebsiteGitHub

implement-openapi-gen

Generate OpenAPI specifications and Java SDKs for Firefly Framework services.

Updated Aug 27, 2026
Search Tags:#automation#openapi#maven#springdoc#sdk-generation#firefly
One-click install
npx skills add https://github.com/fireflyframework/fireflyframework-claude-skills --skill implement-openapi-gen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: implement-openapi-gen
Source: https://github.com/fireflyframework/fireflyframework-claude-skills/tree/main/skills/implement-openapi-gen
Command: npx skills add https://github.com/fireflyframework/fireflyframework-claude-skills --skill implement-openapi-gen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Use when generating or configuring OpenAPI specs or SDK generation in a Firefly Framework service. Covers springdoc configuration, @EnableOpenApiGen, the openapi-generator-maven-plugin for SDK generation, AutoMockMissingBeansConfig, and generated package conventions.

Core Features & Use Cases

  • Annotates controllers with Swagger/OpenAPI metadata to derive the OpenAPI spec automatically during build.
  • Generates an SDK from the OpenAPI spec via the openapi-generator-maven-plugin for dedicated -sdk modules.
  • Includes AutoMockMissingBeansConfig and @EnableOpenApiGen to enable OpenAPI generation with minimal infra, suitable for local development and CI pipelines.
  • Demonstrates comprehensive build pipelines from -web to -sdk, including code-first approach, packaging conventions, and tooling integration.
  • Provides end-to-end guidance for new services to produce spec files and clients with zero manual intervention.

Quick Start

Run mvn clean install in the service module after adding dependencies and annotations to trigger OpenAPI spec generation and SDK packaging.

Frequently Asked Questions about implement-openapi-gen

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

FAQPage Schema
How do I generate an OpenAPI spec from Spring controllers automatically?▼

You can generate OpenAPI specifications automatically by annotating Spring controllers with Swagger metadata and using Springdoc during the Maven build. This code-first approach derives the API documentation directly from your existing controller definitions without manual intervention.

How do I generate a Java SDK from an OpenAPI spec using Maven?▼

Generate a Java SDK from an OpenAPI spec by configuring the openapi-generator-maven-plugin within a dedicated -sdk module. Running mvn clean install triggers the plugin to package the client SDK based on your derived specification file.

What is the best way to automate OpenAPI documentation for microservices?▼

Automating OpenAPI documentation for microservices is best achieved by orchestrating controller annotations with OpenAPI tooling. Using @EnableOpenApiGen and AutoMockMissingBeansConfig streamlines the build pipeline from the -web to -sdk modules for both local development and CI.

Do I need a separate module to package a client SDK with openapi-generator-maven-plugin?▼

Yes, packaging a client SDK requires a dedicated -sdk module to configure the openapi-generator-maven-plugin. This separates your generated SDK artifacts from the main -web module, ensuring clean build pipelines and proper packaging conventions.

Can I use Springdoc OpenAPI generation in local development without full infrastructure?▼

Yes, you can use Springdoc for OpenAPI generation in local development without full infrastructure. The AutoMockMissingBeansConfig and @EnableOpenApiGen annotations enable spec generation with minimal setup, making it suitable for local testing and CI pipelines.

Why is my OpenAPI generation failing during the Maven build?▼

OpenAPI generation during a Maven build often fails if controller annotations are missing or the openapi-generator-maven-plugin is misconfigured in the -sdk module. Ensure AutoMockMissingBeansConfig is applied and dependencies are correctly added before running mvn clean install.

Related Skills

Explore More Software Engineering Skills→
giuseppe-trisciuogliogiuseppe-trisciuoglio
322

spring-boot-openapi-documentation

Generate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.

Community
Advanced
gil00pitagil00pita

openapi

Generate OpenAPI 3.1 specifications and TypeScript types from API definitions.

Community
Advanced
jarrodmedranojarrodmedrano
2

level-design

Provide a level-design consulting framework for spatial layouts, player guidance, and pacing.

Community
Basic
Ankurjain1121Ankurjain1121

openapi-spec-generation

Convert API contracts into OpenAPI 3.1 specifications and SDK templates.

Community
Advanced