Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow configuring openapi version #195

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: allow configuring openapi version #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13f0f2a
feat: add property to change openapi version
ViniciusCestarii Mar 11, 2025
46f7f41
feat: add test for openapi version
ViniciusCestarii Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export const swagger = async <Path extends string = '/swagger'>(
scalarCDN = '',
scalarConfig = {},
documentation = {},
openapi = '3.0.3',
version = '5.9.0',
excludeStaticFile = true,
path = '/swagger' as Path,
Expand All @@ -37,6 +38,7 @@ export const swagger = async <Path extends string = '/swagger'>(
scalarCDN: '',
scalarConfig: {},
documentation: {},
openapi: '3.0.3',
version: '5.9.0',
excludeStaticFile: true,
path: '/swagger' as Path,
Expand Down Expand Up @@ -152,7 +154,7 @@ export const swagger = async <Path extends string = '/swagger'>(
}

return {
openapi: '3.0.3',
openapi: openapi,
...{
...documentation,
tags: documentation.tags?.filter(
Expand Down
6 changes: 6 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
* @see https://github.com/scalar/scalar/blob/main/documentation/configuration.md
*/
scalarConfig?: ReferenceConfiguration
/**
* OpenAPI version to be used
*
* @default 3.0.3
*/
openapi?: string;
/**
* Version to use for swagger cdn bundle
*
Expand Down
13 changes: 13 additions & 0 deletions test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,19 @@ describe('Swagger', () => {
expect(res.trim().includes(expected.trim())).toBe(true)
})

it('OpenAPI version', async () => {
const app = new Elysia().use(
swagger({
openapi: '3.1.0'
})
)

await app.modules

const res = await app.handle(req('/swagger/json')).then((x) => x.json())
expect(res.openapi).toBe('3.1.0')
})

it('should not return content response when using Void type', async () => {
const app = new Elysia().use(swagger()).get('/void', () => {}, {
response: {
Expand Down