Nestjs Openapi Docs
CheckedGenerates interactive OpenAPI documentation for NestJS projects automatically, streamlining API development and collaboration.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add jacarrara/skills --skill nestjs-openapi-docs -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
jacarrara
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned jacarrara/skills at 8f8f79e2f8.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 8f8f79e2f8
- Scanned
- 5 files, 1,206 lines
About this skill
What it does
This skill automatically generates OpenAPI documentation from a NestJS application. It leverages the @nestjs/swagger decorator and configuration to produce interactive API documentation that can be used for development, testing, and public consumption. The generated documentation includes endpoint descriptions, request parameters, response models, and security schemes.
When to use it
- API Documentation: Quickly create up-to-date API documentation for your NestJS backend applications without manual effort.
- Developer Onboarding: Provide new developers with clear and concise API references to accelerate their understanding of the codebase.
- Public API Exposure: Generate a public-facing API reference for external consumers or partners.
- Automated Testing: Utilize the generated OpenAPI specification for automated testing and contract validation.
Key capabilities
- Generates OpenAPI documentation from NestJS applications.
- Utilizes
@nestjs/swaggerdecorators for endpoint definition. - Supports interactive Swagger UI for visualization.
- Creates a downloadable OpenAPI specification file (JSON or YAML).
Example prompts
- "Generate the OpenAPI documentation for my NestJS application."
- "Create an OpenAPI spec file in JSON format from my NestJS project."
- "Show me the Swagger UI for my API."
Tips & gotchas
- Ensure
@nestjs/swaggeris installed and configured correctly within your NestJS project. The skill relies on this dependency to function properly.