# @greguintow/nestjs-swagger 中文文档

规范地址：https://npmcn.com/package/%40greguintow/nestjs-swagger/

版本：7\.4\.0
npm 元数据更新时间：2024-03-17T05:15:16.519Z
中文译文更新时间：2026-11-17T00:18:35.771Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40greguintow/nestjs-swagger
原文对照：https://npmcn.com/package/%40greguintow/nestjs-swagger/?lang=original
项目主页：https://github.com/greguintow/nestjs-swagger#readme
源码仓库：https://github.com/greguintow/nestjs-swagger

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：305 kB，214 个文件
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：@fastify/static ^6\.0\.0 \|\| ^7\.0\.0，@nestjs/common ^9\.0\.0 \|\| ^10\.0\.0，@nestjs/core ^9\.0\.0 \|\| ^10\.0\.0，class-transformer \*，class-validator \*，reflect-metadata ^0\.1\.12 \|\| ^0\.2\.0
- 首次发布：2022-01-08T23:51:45.715Z
- 最新版本发布：2024-03-17T05:15:15.804Z
- 近 30 天下载量：18371（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

Nest - 现代,快速,强大的节点.js web框架 (@swagger)

## 安装

```sh
npm install @greguintow/nestjs-swagger
```

也可以使用：`pnpm add @greguintow/nestjs-swagger`、`yarn add @greguintow/nestjs-swagger`、`bun add @greguintow/nestjs-swagger`

## README

[![Nest Logo](https://nestjs.com/img/logo-small.svg)](http://nestjs.com/)

一个进步 [节点.js](http://nodejs.org/) 用于建立高效和可扩展的服务器侧应用程序的框架.

[![NPM Version](https://img.shields.io/npm/v/@nestjs/core.svg)](https://www.npmjs.com/~nestjscore) [![Package License](https://img.shields.io/npm/l/@nestjs/core.svg)](https://www.npmjs.com/~nestjscore) [![NPM Downloads](https://img.shields.io/npm/dm/@nestjs/core.svg)](https://www.npmjs.com/~nestjscore) [![CircleCI](https://img.shields.io/circleci/build/github/nestjs/nest/master)](https://circleci.com/gh/nestjs/nest) [![Coverage](https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5)](https://coveralls.io/github/nestjs/nest?branch=master) [![Discord](https://img.shields.io/badge/discord-online-brightgreen.svg)](https://discord.gg/G7Qnnhy) [![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer) [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor) [![](https://img.shields.io/badge/Donate-PayPal-dc3d53.svg)](https://paypal.me/kamilmysliwiec) [![](https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow)](https://twitter.com/nestframework)

## 说明

[OpenAPI (斯瓦格语)](https://www.openapis.org/) 模块 [鸟巢](https://github.com/nestjs/nest)。 。 。 .

## 安装

```bash
$ npm i --save @nestjs/swagger 
```

## 快速启动

[概览( T)](https://docs.nestjs.com/openapi/introduction)

## 从v3迁移

如果你现在使用 `@nestjs/swagger@3.*`,注意以下4.0版本的断开/API修改.

下列装饰被更改/更名:

-   `@ApiModelProperty` 现在 `@ApiProperty`
-   `@ApiModelPropertyOptional` 现在 `@ApiPropertyOptional`
-   `@ApiResponseModelProperty` 现在 `@ApiResponseProperty`
-   `@ApiImplicitQuery` 现在 `@ApiQuery`
-   `@ApiImplicitParam` 现在 `@ApiParam`
-   `@ApiImplicitBody` 现在 `@ApiBody`
-   `@ApiImplicitHeader` 现在 `@ApiHeader`
-   `@ApiOperation({ title: 'test' })` 现在 `@ApiOperation({ summary: 'test' })`
-   `@ApiUseTags` 现在 `@ApiTags`

`DocumentBuilder` 断开更改( 更新方法签名) :

-   `addTag`
-   `addBearerAuth`
-   `addOAuth2`
-   `setContactEmail` 现在 `setContact`
-   `setHost` 已删除
-   `setSchemes` 已删除(使用 `addServer` 例如, `addServer('http://')`(中文(简体) )

增加了以下方法:

-   `addServer`
-   `addApiKey`
-   `addBasicAuth`
-   `addSecurity`
-   `addSecurityRequirements`

## 支助

Nest是麻省理工学院许可的开源项目. 它可以增长多亏赞助商和惊人的支持者的支持. 如果你想加入他们,请 [这里读更多](https://docs.nestjs.com/support)。 。 。 .

## 保持联系

-   作者 - 翻译 [卡米尔·迈利维克(英语:Kamil Myśliwiec)](https://twitter.com/kammysliwiec)
-   网站 - [https://nestjs.com (中文(简体) )](https://nestjs.com/)
-   微博 - [@ 无框架](https://twitter.com/nestframework)

## 许可证

巢为 [麻省理工学院执照](https://npmcn.com/package/%40greguintow/nestjs-swagger/LICENSE)。 。 。 .

## 常见问题

### @greguintow/nestjs-swagger 是什么？

Nest - 现代,快速,强大的节点\.js web框架 \(@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 和提交记录判断。

