swagger-annotation

Standardize Swagger/OpenAPI annotations for Java and Kotlin DTOs and controllers.

Updated Jan 16, 2026

Search Tags:#openapi #java #swagger #kotlin #annotations #api-documentation

Ready to run

npx skills add https://github.com/hyxklee/AI-DEV-ToolKit --skill swagger-annotation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: swagger-annotation
Source: https://github.com/hyxklee/AI-DEV-ToolKit/tree/main/claude/skills/swagger-annotation
Command: npx skills add https://github.com/hyxklee/AI-DEV-ToolKit --skill swagger-annotation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Swagger/OpenAPI 어노테이션을 일관되게 작성하고 관리하기 어려운 문제를 해결합니다.

Core Features & Use Cases

일관된 @Schema, @Operation, @ApiResponses 어노테이션 사용 규칙 제시
DTO 및 Controller에 예시와 패턴 제공
SpringDoc OpenAPI 기반 프로젝트의 API 문서화를 돕는 가이드

Quick Start

Apply the standardized Swagger/OpenAPI annotations to your Java/Kotlin DTOs and controllers to produce consistent API documentation.

Frequently Asked Questions about swagger-annotation

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

FAQPage Schema

How do I standardize Swagger annotations for consistent API documentation across Java and Kotlin projects?▼

You can standardize Swagger annotations by applying a consistent rule set for @Schema, @Operation, and @ApiResponses across your Java and Kotlin DTOs and Controllers. This provides uniform API documentation practices for your entire development team.

What is the best way to document SpringDoc OpenAPI controllers and DTOs?▼

The best way to document SpringDoc OpenAPI controllers and DTOs is by following standardized patterns for @Operation, @Schema, and @ApiResponses. Using provided examples ensures your API documentation remains clean, structured, and consistent across all endpoints.

Can I use the same OpenAPI annotation patterns for both Kotlin and Java DTOs?▼

Yes, you can use the same OpenAPI annotation patterns for both Kotlin and Java DTOs. The standardized practices for @Schema and @ApiResponses are designed to be applicable across both languages, ensuring consistent API documentation regardless of your chosen JVM language.

Why does my team have inconsistent API documentation when using @Operation and @Schema annotations?▼

Your team has inconsistent API documentation because Swagger annotations lack enforced usage rules. Applying a standardized rule set for @Schema, @Operation, and @ApiResponses with specific examples and patterns resolves this by guiding uniform annotation practices across all SpringDoc OpenAPI projects.

Do I need SpringDoc OpenAPI to use these standardized Swagger annotation practices?▼

Yes, you need SpringDoc OpenAPI. These standardized Swagger annotation practices are specifically designed for SpringDoc OpenAPI-based applications to guide API documentation generation and ensure consistent @Schema and @Operation usage within that ecosystem.