# @elysiajs/openapi 中文文档

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

版本：1\.4\.17
npm 元数据更新时间：2026-11-04T03:49:12.083Z
中文译文更新时间：2026-11-13T14:17:34.228Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.2 MB，33 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：elysia \>= 1\.4\.0，typescript \>= 5\.0\.0，@sinclair/typebox \>= 0\.34\.0 \< 1
- 首次发布：2025-09-02T16:21:56.071Z
- 最新版本发布：2026-11-04T03:49:11.659Z
- 近 30 天下载量：2059779（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 7 个）

## 中文简介

添加 OpenAPI 文档的 Elysia 插件

## 安装

```sh
npm install @elysiajs/openapi
```

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

## README

# @elysia/ openapi

[爱莉西亚](https://github.com/elysiajs/elysia) 添加 OpenAPI 文档的插件 .

## 安装

```bash
bun add @elysia/openapi
```

## 示例

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

const app = new Elysia()
    .use(openapi())
    .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(3000)
```

那就去那边 `http://localhost:3000/openapi`。 。 。 .

# 配置

## 启用

@ 默认为真 启用/ 禁用插件

## 打开apiVersion

@ 默认' 3.1.2'

要发射的 OpenAPI 文档版本 。 支持 OpenAPI `3.0.x` 财务报告和审定财务报表 `3.1.x`。 。 。 .

## 文档

OpenAPI 文档信息

@ 见 [https://spec.openapis.org/oas/latest.html (中文(简体) )](https://spec.openapis.org/oas/latest.html)

## 排除

从文档中排除路径或方法的配置

## 排除.方法

从文件中删除的方法清单

## 排除.路径

排除文档的路径清单

## 排除.静态文件

@ 默认为真

从文档中排除静态文件路径

## 排除

从文档中排除的标签清单

## 路径

默认“ / openapi ”

曝光 OpenAPI 文档前端的终点

## 提供者

默认“ scalar ”

OpenAPI 文档前端介于 :

-   [斯卡尔](https://github.com/scalar/scalar)
-   [斯瓦格维](https://github.com/swagger-api/swagger-ui)
-   无效: 禁用前端

## 参考文献

每个端点的额外 OpenAPI 引用

## 斯卡尔

Scalar 配置, 参考 [斯卡拉尔配置](https://github.com/scalar/scalar/blob/main/documentation/configuration.md)

## 光谱

@ 默认“ ${ path}/ json”

用 JSON 格式曝光 OpenAPI 规格的终点

## 摇摆

Swagger 配置, 参考 [斯瓦格配置](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/)

见 [文档](https://elysiajs.com/plugins/openapi.html) 更多细节.

## 常见问题

### @elysiajs/openapi 是什么？

添加 OpenAPI 文档的 Elysia 插件

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

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

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

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

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

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

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

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

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

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

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

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