nean-api-docs
CommunityGenerate and serve NestJS OpenAPI docs.
Authoredfenton
Version1.0.0
Installs0
System Documentation
What problem does it solve?
NestJS projects struggle to maintain accurate, accessible API documentation. This skill automatically generates and serves OpenAPI (Swagger) docs from NestJS decorators, keeping docs in sync with code.
Core Features & Use Cases
- Generate OpenAPI specs from @nestjs/swagger decorators on controllers and DTOs.
- Serve Swagger UI at a configurable path (e.g., /api/docs) and export the spec to a file.
- Audit endpoints for missing documentation and ensure consistent tagging and responses.
Quick Start
Enable Swagger by running the serve option to expose the API docs at /api/docs and export the OpenAPI spec to a file with the export option.
Dependency Matrix
Required Modules
@nestjs/core@nestjs/swagger
Components
scriptsreferences
💻 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: nean-api-docs Download link: https://github.com/edfenton/claude-skills/archive/main.zip#nean-api-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.