api-docs-reference

Community

Convert REST Docs into OpenAPI & Swagger UI docs.

Authorkssumin
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Streamlines API documentation by bridging REST Docs with OpenAPI 3, generating up-to-date specifications and Swagger UI for Spring services.

Core Features & Use Cases

  • Integrates Spring REST Docs with OpenAPI 3 to produce a single, consistent API spec.
  • Provides Swagger UI setup to browse documentation at runtime.
  • Demonstrates test patterns for POST/GET, pagination, and error cases, along with a reusable field utility.

Quick Start

Configure your Spring project to generate an OpenAPI spec from REST Docs and serve it through Swagger UI.

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: api-docs-reference
Download link: https://github.com/kssumin/claude-playground/archive/main.zip#api-docs-reference

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.