# @elysiajs/swagger 中文文档

规范地址：https://npmcn.com/package/%40elysiajs/swagger/

版本：1\.3\.1
npm 元数据更新时间：2025-06-27T21:24:10.509Z
中文译文更新时间：2026-11-13T14:17:40.016Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：144 kB，26 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：elysia \>= 1\.3\.0
- 首次发布：2022-12-04T14:03:23.759Z
- 最新版本发布：2025-06-27T21:24:09.771Z
- 近 30 天下载量：1117230（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 0 个）

## 中文简介

Elysia 自动生成 Swagger 页面的插件

## 安装

```sh
npm install @elysiajs/swagger
```

也可以使用：`pnpm add @elysiajs/swagger`、`yarn add @elysiajs/swagger`、`bun add @elysiajs/swagger`

## README

# @elysiajs/ swagger (英语)

插件用于 [爱乐](https://github.com/elysiajs/elysia) 以自动生成 Swagger 页面.

## 安装

```bash
bun add @elysiajs/swagger
```

## 示例

```typescript
import { Elysia, t } from 'elysia'
import { swagger } from '@elysiajs/swagger'

const app = new Elysia()
    .use(swagger())
    .get('/', () => 'hi', { response: t.String({ description: 'sample description' }) })
    .post(
        '/json/:id',
        ({ body, params: { id }, query: { name } }) => ({
            ...body,
            id,
            name
        }),
        {
            params: t.Object({
                id: t.String()
            }),
            query: t.Object({
                name: t.String()
            }),
            body: t.Object({
                username: t.String(),
                password: t.String()
            }),
            response: t.Object({
                username: t.String(),
                password: t.String(),
                id: t.String(),
                name: t.String()
            }, { description: 'sample description' })
        }
    )
    .listen(8080);
```

那就去那边 `http://localhost:8080/swagger`。 。 。 .

# 配置

## 提供者

默认“ scalar ” 选择 [斯卡尔](https://github.com/scalar/scalar) 打开 [斯瓦格维](https://github.com/swagger-api/swagger-ui)

## 斯卡尔

自定义 scalarconfig, 指的是 [斯卡拉尔配置](https://github.com/scalar/scalar/blob/main/documentation/configuration.md)

## 摇摆

自定义 Swagger 配置, 指的是 [斯瓦格 3. 0.3 配置](https://swagger.io/specification/v3)

## 路径

默认“ / swagger ”

揭发斯瓦格的终点

## 排除结构文件

@ 默认为真

确定Swagger是否排除静态文件 .

## 排除

@ 默认 \[\]

从 Swagger 端点排除路径

## 常见问题

### @elysiajs/swagger 是什么？

Elysia 自动生成 Swagger 页面的插件

### 如何安装 @elysiajs/swagger？

在项目目录运行 npm install @elysiajs/swagger，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：elysia（\>= 1\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @elysiajs/swagger 支持 TypeScript 吗？

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

### @elysiajs/swagger 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @elysiajs/swagger 可以商用吗？

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

### @elysiajs/swagger 的下载量有多少？

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

### @elysiajs/swagger 还在维护吗？

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