nean-api-docs

Generate and serve OpenAPI documentation from @nestjs/swagger decorators.

3|1|Updated Feb 12, 2026

Search Tags:#documentation #openapi #audit #swagger #nestjs #decorators

Ready to run

npx skills add https://github.com/edfenton/claude-skills --skill nean-api-docs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: nean-api-docs
Source: https://github.com/edfenton/claude-skills/tree/main/nean/nean-api-docs
Command: npx skills add https://github.com/edfenton/claude-skills --skill nean-api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @nestjs/core, @nestjs/swagger, and includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about nean-api-docs

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

FAQPage Schema

How do I generate OpenAPI documentation for a NestJS API?▼

Generate OpenAPI documentation for a NestJS API by using this skill to read @nestjs/swagger decorators on controllers and DTOs, automatically producing a synced Swagger spec without manual writing.

Can I serve Swagger UI at a custom path in NestJS?▼

Yes, you can serve Swagger UI at a configurable path in NestJS, such as /api/docs, by running the serve option in your main.ts setup to expose interactive API documentation.

How do I audit NestJS endpoints for missing documentation?▼

Audit NestJS endpoints for missing documentation by using this skill's automated auditing feature, which checks your controllers and DTOs to ensure consistent tagging and complete response coverage.

How do I export an OpenAPI spec to a file in NestJS?▼

Export an OpenAPI spec to a file in NestJS by running the dedicated export script provided by this skill, translating your decorator annotations into a static JSON or YAML specification file.

Does this documentation generator work with NestJS projects of varying sizes?▼

Yes, this OpenAPI documentation generator works with NestJS projects of varying sizes, supporting decorator-based generation and automated auditing for consistent API documentation across large and small codebases.