Skills
.Work. You
Rest

spring-openapi

Community

Generate Spring APIs from your OpenAPI spec

Software Engineering#openapi#code generation#api contract#swagger ui#spring boot 4#server interfaces#spec-first development
Authordprice-dev
Version1.0.0
Installs0

System Documentation

What problem does it solve?

It eliminates the mismatch and rework that happen when API contracts and backend implementations drift apart by making your OpenAPI YAML the source of truth for controllers and DTOs.

Core Features & Use Cases

  • OpenAPI-first contract workflow: Author paths, schemas, and operationIds in src/main/resources/openapi/api.yaml and use that spec to drive implementation.
  • Spec-driven code generation: Generate Spring Boot server interfaces and model types from the spec, then implement the generated interfaces in your own controllers.
  • Static SwaggerUI documentation: Serve Swagger UI from the static spec file so your documentation reflects the contract you wrote.
  • Use Case: You define endpoints like POST /orders and schema objects like CreateOrderRequest and OrderResponse, regenerate code, implement the generated *Api interface, and validate client/server expectations against the same contract.

Quick Start

Indent and edit your API contract in src/main/resources/openapi/api.yaml, then run compile to regenerate the interfaces and models and implement the generated *Api methods.

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: spring-openapi
Download link: https://github.com/dprice-dev/claude-java-skills/archive/main.zip#spring-openapi

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 471,000+ vetted skills library on demand.