NestJS Swagger (OpenAPI) Snippets
Quick, consistent @nestjs/swagger decorator and DocumentBuilder snippets for faster API documentation in NestJS.
Overview
This Visual Studio Code extension provides ready-to-use snippets for the @nestjs/swagger package and the DocumentBuilder API. The snippets help you document controllers, DTOs and API metadata faster and more consistently.
Requirements
- Visual Studio Code 1.46.0 or later
Installation
- Open Visual Studio Code (or a compatible editor).
- Open the Extensions view (
Ctrl+Shift+X / ⌘+Shift+X).
- Search for NestJS Swagger (OpenAPI) Snippets or install directly from the Marketplace page.
- Click Install and reload the editor if prompted.
Usage
Type part of a snippet name and press Tab or Enter to expand it.
Note: Many snippets have two triggers — a namespaced one (e.g. ns_swagger_deco_api_operation) and a more natural alias (e.g. @ApiOperation or setTitle). You can use either.
Common snippets
| Snippet |
Purpose |
ns_swagger_deco_api_basic_auth |
@ApiBasicAuth |
ns_swagger_deco_api_bearer_auth |
@ApiBearerAuth |
ns_swagger_deco_api_body |
@ApiBody |
ns_swagger_deco_api_consumes |
@ApiConsumes |
ns_swagger_deco_api_cookie_auth |
@ApiCookieAuth |
ns_swagger_deco_api_exclude_controller |
@ApiExcludeController |
ns_swagger_deco_api_operation |
@ApiOperation |
ns_swagger_deco_api_param |
@ApiParam |
ns_swagger_deco_api_property |
@ApiProperty |
ns_swagger_deco_api_query |
@ApiQuery |
ns_swagger_deco_api_tags |
@ApiTags |
ns_swagger_deco_api_ok_response |
@ApiOkResponse |
ns_swagger_deco_api_bad_request_response |
@ApiBadRequestResponse |
ns_swagger_deco_api_unauthorized_response |
@ApiUnauthorizedResponse |
ns_swagger_deco_api_not_found_response |
@ApiNotFoundResponse |
ns_swagger_deco_api_internal_server_error_response |
@ApiInternalServerErrorResponse |
ns_swagger_deco_api_default_response |
@ApiDefaultResponse |
ns_swagger_set_title |
setTitle (DocumentBuilder) |
ns_swagger_set_description |
setDescription (DocumentBuilder) |
ns_swagger_set_version |
setVersion (DocumentBuilder) |
ns_swagger_set_contact |
setContact (DocumentBuilder) |
ns_swagger_set_license |
setLicense (DocumentBuilder) |
ns_swagger_add_server |
addServer (DocumentBuilder) |
ns_swagger_add_tag |
addTag (DocumentBuilder) |
ns_swagger_add_security |
addSecurity (DocumentBuilder) |
ns_swagger_build |
build() (DocumentBuilder) |
Contributing
Contributions to the NestJS Swagger (OpenAPI) Snippets are welcome and appreciated. To contribute:
Fork the GitHub repository.
Create a new branch for your feature or fix:
git checkout -b feature/your-feature
Make your changes, commit them, and push to your fork.
Submit a Pull Request targeting the main branch.
Before contributing, please review the Contribution Guidelines for coding standards, testing, and commit message conventions. If you encounter a bug or wish to request a new feature, please open an Issue.
Changelog
For a complete list of changes, see the CHANGELOG.md.
Authors
For a complete list of contributors, please refer to the contributors page.
Follow Me
- GitHub:
- X (formerly Twitter):
Other Extensions
Auto Barrel
Automatically generates and maintains barrel (index.ts) files for your TypeScript projects.
Angular File Generator
Generates boilerplate and navigates your Angular (9→20+) project from within the editor, with commands for components, services, directives, modules, pipes, guards, reactive snippets, and JSON2TS transformations.
NestJS File Generator
Simplifies creation of controllers, services, modules, and more for NestJS projects, with custom commands and Swagger snippets.
NestJS Snippets
Ready-to-use code patterns for creating controllers, services, modules, DTOs, filters, interceptors, and more in NestJS.
T3 Stack / NextJS / ReactJS File Generator
Automates file creation (components, pages, hooks, API routes, etc.) in T3 Stack (Next.js, React) projects and can start your dev server from VSCode.
Drizzle ORM Snippets
Collection of code snippets to speed up Drizzle ORM usage, defines schemas, migrations, and common database operations in TypeScript/JavaScript.
CodeIgniter 4 Spark
Scaffolds controllers, models, migrations, libraries, and CLI commands in CodeIgniter 4 projects using Spark, directly from the editor.
CodeIgniter 4 Snippets
Snippets for accelerating development with CodeIgniter 4, including controllers, models, validations, and more.
CodeIgniter 4 Shield Snippets
Snippets tailored to CodeIgniter 4 Shield for faster authentication and security-related code.
Mustache Template Engine - Snippets & Autocomplete
Snippets and autocomplete support for Mustache templates, making HTML templating faster and more reliable.
Recommended Browser Extension
For developers who work with .vsix files for offline installations or distribution, the complementary One-Click VSIX extension is recommended, available for both Chrome and Firefox.
One-Click VSIX integrates a direct "Download Extension" button into each VSCode Marketplace page, ensuring the file is saved with the .vsix extension, even if the server provides a .zip archive. This simplifies the process of installing or sharing extensions offline by eliminating the need for manual file renaming.
License
This project is licensed under the MIT License. See the LICENSE file for full details.
| |
