@elysiajs/ swagger (英语)

插件用于 爱乐 以自动生成 Swagger 页面.

安装

bun add @elysiajs/swagger

示例

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 ” 选择 斯卡尔 打开 斯瓦格维

斯卡尔

自定义 scalarconfig, 指的是 斯卡拉尔配置

摇摆

自定义 Swagger 配置, 指的是 斯瓦格 3. 0.3 配置

路径

默认“ / swagger ”

揭发斯瓦格的终点

排除结构文件

@ 默认为真

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

排除

@ 默认 []

从 Swagger 端点排除路径