Can this skill improve my generated SDKs?

Yes, by enforcing the use of 'enumName' and explicit type definitions for arrays, it ensures that generated clients have accurate types and enums.

How does this skill handle validation decorators?

It automatically aligns class-validator decorators like @Min, @Max, and @IsOptional with their corresponding Swagger properties to ensure your documentation matches your code logic.

Does it support internationalization in documentation?

The skill specifically promotes a pattern of using descriptive text in your local language (e.g., Korean) while providing standard format values for examples.

Does it provide templates for both requests and responses?

Yes, it includes distinct templates for Request DTOs (validation focused) and Response DTOs (structure focused) to cover the full API lifecycle.

NestJS Swagger Documenter

Name: NestJS Swagger Documenter
Author: m16khb

bym16khb

0•

Desarrollo de API

Standardizes NestJS DTO and Controller documentation using Swagger decorators to ensure high-quality, client-ready API specifications.

The NestJS Swagger Documenter skill provides a robust framework for implementing OpenAPI standards within NestJS applications. It enforces essential documentation practices, such as mandatory property descriptions, realistic examples, and the synchronization of class-validator decorators with Swagger attributes. By utilizing specialized templates for DTOs and Controllers, it ensures that API documentation is not only comprehensive but also optimized for client-side SDK generation through features like mandatory enum names and explicit type definitions. This skill is ideal for teams looking to improve API discoverability and provide frontend developers with clear, actionable documentation.

Características Principales

010 GitHub stars

02Automated DTO template generation for standardized requests and responses

03Smart mapping between class-validator decorators and Swagger attributes

04Enhanced readability using Markdown tables for complex status and option descriptions

05SDK optimization through mandatory enumName and explicit type definitions

06Standardized Controller documentation patterns with @ApiOperation and @ApiResponse

Casos de Uso

01Generating production-grade OpenAPI (Swagger) documentation for NestJS backends

02Enforcing documentation consistency across large-scale microservices

03Optimizing API schemas for reliable frontend SDK and client generation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add m16khb/cc-essential nestjs-swagger

For use in Claude.ai and ChatGPT

Download Skill