# @clementoh/better-openapi-viewer-nestjs 中文文档

规范地址：https://npmcn.com/package/%40clementoh/better-openapi-viewer-nestjs/

版本：0\.1\.8
npm 元数据更新时间：2026-05-12T15:18:07.040Z
中文译文更新时间：2026-11-10T01:08:12.089Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：24.1 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@nestjs/common ^11\.1\.19，@nestjs/core ^11\.1\.19
- 首次发布：2026-05-07T04:22:49.598Z
- 最新版本发布：2026-05-12T15:18:06.953Z
- 近 30 天下载量：5690（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

NestJS适配器用于更好的OpenAPI查看器.

## 安装

```sh
npm install @clementoh/better-openapi-viewer-nestjs
```

也可以使用：`pnpm add @clementoh/better-openapi-viewer-nestjs`、`yarn add @clementoh/better-openapi-viewer-nestjs`、`bun add @clementoh/better-openapi-viewer-nestjs`

## README

# 页面存档备份,存于互联网档案馆 clementoh/better-openapi-viewer-nestjs

NestJS适配器用于更好的OpenAPI查看器.

## 使用量

```ts
import { SwaggerModule } from '@nestjs/swagger';
import { setupBetterOpenApiViewer } from '@clementoh/better-openapi-viewer-nestjs';

const document = SwaggerModule.createDocument(app, swaggerConfig);

setupBetterOpenApiViewer(app, {
  path: 'docs',
  jsonPath: 'docs/openapi.json',
  document,
  title: 'Example API',
  defaultExpansion: 'list',
  deepLinking: true,
  filter: true,
  displayRequestDuration: true,
  supportedSubmitMethods: ['get', 'post', 'patch', 'delete'],
  persistAuthorization: false,
});
```

适配器服务于OpenAPI JSON文档和一个轻量级取景器外壳而无需更改NestJS的装饰器或 `@nestjs/swagger` 文档生成.

## 多个文档

使用 `specs` 当同一 NestJS app 显示不止一个 OpenAPI 文档时. 每个光谱都得到了自己的JSON端点,而取景器会制作一个小的文档切换器.

```ts
setupBetterOpenApiViewer(app, {
  path: 'docs',
  specs: [
    {
      name: 'Public API',
      path: 'docs/public',
      jsonPath: 'docs/public/openapi.json',
      document: publicDocument,
    },
    {
      name: 'Admin API',
      path: 'docs/admin',
      jsonPath: 'docs/admin/openapi.json',
      documentFactory: () => SwaggerModule.createDocument(app, adminSwaggerConfig),
    },
  ],
});
```

何时 `path` 或者说 `jsonPath` ,适配器从顶层获得稳定路线 `path` 和谱名.

## 静态资产

后退 shell今天支持自定义 CSS 和 JavaScript URL 。 如果您在应用程序中捆绑额外的UI资产, 请通过一个薄的服务钩并公开挂载路径 :

```ts
import { join } from 'node:path';
import { serveBetterOpenApiViewerStaticAssets } from '@clementoh/better-openapi-viewer-nestjs';

setupBetterOpenApiViewer(app, {
  document,
  staticAssets: {
    path: 'docs/assets',
    serve: serveBetterOpenApiViewerStaticAssets(join(process.cwd(), 'public/openapi-viewer')),
  },
});
```

帮手叫巢穴 `useStaticAssets` 当活动平台曝光时. 你可以自己提供 `serve` 调用适配器特定设置 .

## 常见问题

### @clementoh/better-openapi-viewer-nestjs 是什么？

NestJS适配器用于更好的OpenAPI查看器\.

### 如何安装 @clementoh/better-openapi-viewer-nestjs？

在项目目录运行 npm install @clementoh/better-openapi-viewer-nestjs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nestjs/common（^11\.1\.19）、@nestjs/core（^11\.1\.19）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @clementoh/better-openapi-viewer-nestjs 支持 TypeScript 吗？

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

### @clementoh/better-openapi-viewer-nestjs 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @clementoh/better-openapi-viewer-nestjs 可以商用吗？

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

### @clementoh/better-openapi-viewer-nestjs 的下载量有多少？

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

### @clementoh/better-openapi-viewer-nestjs 还在维护吗？

最新版本 0\.1\.8 发布于 2026/05/12（5 个月前）；至今共发布 8 个版本，其中过去 12 个月发布了 8 个；首次发布于 2026/05/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。