How is API authentication documented with this skill?

It supports granular security schemes like @ApiBearerAuth() and @ApiSecurity(), ensuring that the Swagger UI matches the authentication configuration in the DocumentBuilder.

Can I use this for documenting file uploads?

Absolutely. It handles the explicit documentation of multipart/form-data requirements, including binary format definitions for file properties in the request body.

How does this skill reduce boilerplate in NestJS?

It leverages the Nest CLI Swagger plugin to automatically infer metadata from DTO classes and response types, removing the need for manual @ApiProperty decorators on every field.

Does it support multiple API versions or audiences?

Yes, it includes patterns for generating separate Swagger documents for different audiences, such as public vs. internal modules or v1 vs. v2 endpoints.

Can it handle documentation for generic response types?

Yes, it provides patterns for using ApiExtraModels and getSchemaPath within custom decorators to correctly document generic wrappers like PageDto .

NestJS OpenAPI & Swagger Automation

Name: NestJS OpenAPI & Swagger Automation
Author: fierzone

byfierzone

•

API 开发

Automates the generation of production-grade OpenAPI documentation and Swagger UI for NestJS applications.

This skill empowers Claude to implement and maintain comprehensive API documentation for NestJS projects using the @nestjs/swagger ecosystem. It focuses on reducing boilerplate through the Nest CLI plugin, handling complex scenarios like generic paginated responses and polymorphic types, and ensuring secure API documentation through granular authentication schemes. By enforcing best practices like operation grouping, versioning, and explicit response typing, it helps developers create clear, interactive API references that stay perfectly in sync with their codebase while reducing manual decorator overhead by up to 50%.

主要功能

01Advanced generic response handling for paginated and wrapped DTOs

02Zero-boilerplate documentation using Nest CLI Plugin integration

03Multi-document generation to segregate public and internal API endpoints

04Support for complex schema types including polymorphism and file uploads

05Automated security scheme configuration for JWT and API keys

062 GitHub stars

使用场景

01Refactoring existing DTOs to include automated OpenAPI metadata via the Nest CLI plugin

02Generating comprehensive Swagger documentation for a new NestJS microservice

03Implementing custom decorators to handle documentation for generic paginated responses

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add fierzone/agent-skills-standard nestjs

For use in Claude.ai and ChatGPT

Download Skill