@nestjs/swagger
Advanced tools
A progressive Node.js framework for building efficient and scalable server-side applications.
OpenAPI (Swagger) module for Nest.
$ npm i --save @nestjs/swagger
If you're currently using @nestjs/swagger@3.*, note the following breaking/API changes in version 4.0.
The following decorators have been changed/renamed:
@ApiModelProperty is now @ApiProperty@ApiModelPropertyOptional is now @ApiPropertyOptional@ApiResponseModelProperty is now @ApiResponseProperty@ApiImplicitQuery is now @ApiQuery@ApiImplicitParam is now @ApiParam@ApiImplicitBody is now @ApiBody@ApiImplicitHeader is now @ApiHeader@ApiOperation({ title: 'test' }) is now @ApiOperation({ summary: 'test' })@ApiUseTags is now @ApiTagsDocumentBuilder breaking changes (updated method signatures):
addTagaddBearerAuthaddOAuth2setContactEmail is now setContactsetHost has been removedsetSchemes has been removed (use the addServer instead, e.g., addServer('http://'))The following methods have been added:
addServeraddApiKeyaddBasicAuthaddSecurityaddSecurityRequirementsNest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
Nest is MIT licensed.
This package is used to serve auto-generated swagger-ui generated API docs from express, similar to how @nestjs/swagger works with NestJS. It does not provide decorators but instead relies on a Swagger JSON or YAML file.
This package allows for the integration of Swagger using JSDoc comments directly in your code, rather than decorators. It's more suited for applications that are not using TypeScript or NestJS.
This is a Fastify plugin that provides similar functionalities for Fastify applications. It generates Swagger documentation for the Fastify API, similar to how @nestjs/swagger does for NestJS.
FAQs
Nest - modern, fast, powerful node.js web framework (@swagger)
The npm package @nestjs/swagger receives a total of 3,641,587 weekly downloads. As such, @nestjs/swagger popularity was classified as popular.
We found that @nestjs/swagger demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Widespread GitHub phishing campaign uses fake Visual Studio Code security alerts in Discussions to trick developers into visiting malicious website.
Security News
Five malicious npm packages typosquatting crypto libraries steal private keys via Telegram, targeting Solana and Ethereum developers, with active C2 infrastructure.
Security News
TeamPCP is targeting security tools across the OSS ecosystem, turning scanners and CI pipelines into infostealers to access enterprise secrets.