@greguintow/nestjs-swagger

中文文档
7.4.0发布于 2024/03/17MITTypeScript近 30 天下载 1.8万

Nest - modern, fast, powerful node.js web framework (@swagger)

原始使用文档
文档目录7 节
  1. Description
  2. Installation
  3. Quick Start
  4. Migration from v3
  5. Support
  6. Stay in touch
  7. License

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective

Description

OpenAPI (Swagger) module for Nest.

Installation

$ npm i --save @nestjs/swagger 

Quick Start

Overview & Tutorial

Migration from v3

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 @ApiTags

DocumentBuilder breaking changes (updated method signatures):

  • addTag
  • addBearerAuth
  • addOAuth2
  • setContactEmail is now setContact
  • setHost has been removed
  • setSchemes has been removed (use the addServer instead, e.g., addServer('http://'))

The following methods have been added:

  • addServer
  • addApiKey
  • addBasicAuth
  • addSecurity
  • addSecurityRequirements

Support

Nest 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.

Stay in touch

License

Nest is MIT licensed.

版本与发布记录

@greguintow/nestjs-swagger 共发布 5 个版本,首次发布于 2022/01/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
7.4.0latest2024/03/172 年前
6.2.12023/03/133 年前
6.1.42023/01/263 年前
5.1.82022/01/234 年前
5.1.72022/01/094 年前

关于 @greguintow/nestjs-swagger 的常见问题

@greguintow/nestjs-swagger 是什么?

Nest - modern, fast, powerful node.js web framework (@swagger)

如何安装 @greguintow/nestjs-swagger?

在项目目录运行 npm install @greguintow/nestjs-swagger,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@nestjs/common(^9.0.0 || ^10.0.0)、@nestjs/core(^9.0.0 || ^10.0.0)、reflect-metadata(^0.1.12 || ^0.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@greguintow/nestjs-swagger 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@greguintow/nestjs-swagger 可以商用吗?

@greguintow/nestjs-swagger 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@greguintow/nestjs-swagger 的下载量有多少?

根据 npm 官方下载统计,@greguintow/nestjs-swagger 在 2026/10/17 – 2026/11/15 这 30 天内被下载 18,371 次,日均约 612 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@greguintow/nestjs-swagger 还在维护吗?

最新版本 7.4.0 发布于 2024/03/17(2 年前);至今共发布 5 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/01/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。