implement-openapi-gen

Official

Automate OpenAPI spec and SDK generation.

Authorfireflyframework
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: implement-openapi-gen
Download link: https://github.com/fireflyframework/fireflyframework-claude-skills/archive/main.zip#implement-openapi-gen

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.