zoriya/elysia-swagger
1
0
Fork 0
mirror of https://github.com/zoriya/elysia-swagger.git synced 2026-05-31 04:55:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

🎉 feat: 0.3.0-beta.0

Browse Source
This commit is contained in:
saltyaom
2023-02-25 23:55:07 +07:00
parent 2ca1afc230
commit 8341fd6e57
7 changed files with 142 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+8
View File
@@ -1,3 +1,11 @@
# 0.3.0-beta.0 - 25 Feb 2023
Improvement:
- Support Elysia >= 0.3.0-beta.0
Breaking Change:
- Update from OpenAPI 2.x to OpenAPI 3.0.3
- `swagger.swagger` is renamed to `swagger.documentation`
# 0.1.1 - 8 Jan 2023
Bug fix:
- Infers path type
bun.lockb
BIN
View File
Binary file not shown.
example/index.ts
+65 -17
View File
@@ -1,8 +1,23 @@
import { Elysia, t } from 'elysia'
import { Elysia, t, SCHEMA } from 'elysia'
import swagger from '../src/index'
const app = new Elysia()
.use(swagger())
.use(
swagger({
documentation: {
info: {
title: 'Elysia',
version: '0.3.0'
},
tags: [
{
name: 'Test',
description: 'Hello'
}
]
}
})
)
.setModel({
sign: t.Object(
{
@@ -10,13 +25,12 @@ const app = new Elysia()
password: t.String()
},
{
title: 'Sign Model',
description: 'Models for handling authentication'
}
),
number: t.Number()
})
.get('/', () => 'hi', {
.get('/', ({ set }) => 'hi', {
schema: {
detail: {
summary: 'Ping Pong',
@@ -28,13 +42,25 @@ const app = new Elysia()
.get('/unpath/:id', ({ params: { id } }) => id, {
schema: {
params: t.Object({
id: t.String({ description: 'ID to get' })
id: t.String({
description: 'Extract value from path parameter'
})
}),
detail: {
deprecated: true
}
}
})
.post('/json', ({ body }) => body, {
schema: {
contentType: 'application/json',
body: 'sign',
response: 'sign',
detail: {
summary: 'Using reference model'
}
}
})
.post(
'/json/:id',
({ body, params: { id }, query: { name } }) => ({
@@ -42,20 +68,24 @@ const app = new Elysia()
id
}),
{
transform({ params }) {
params.id = +params.id
},
schema: {
body: 'sign',
params: t.Object({
id: t.Number()
}),
response: {
200: t.Object(
{
username: t.String({
title: 'A'
}),
password: t.String(),
id: t.String()
id: t.Number(),
username: t.String(),
password: t.String()
},
{
description: 'A',
title: 'A'
title: 'User',
description: "Contains user's confidential metadata"
}
),
400: t.Object({
@@ -63,16 +93,34 @@ const app = new Elysia()
})
},
detail: {
summary: 'A'
summary: 'Transform path parameter'
}
}
}
)
.get('/unpath/:id/:name', ({ params: { id } }) => id)
.post('/json', ({ body }) => body, {
.post('/file', ({ body: { file } }) => file, {
schema: {
body: 'sign',
response: 'sign'
contentType: 'multipart/form-data',
detail: {
summary: 'Upload file demo',
description:
'An example usage of using Elysia 0.3 to handle file upload'
},
body: t.Object({
file: t.File()
}),
response: t.File()
}
})
.post('/files', ({ body: { files } }) => files[0], {
schema: {
body: t.Object({
files: t.Files({
type: 'image',
maxSize: '5m'
})
}),
response: t.File()
}
})
.listen(8080)
package.json
+6 -6
View File
@@ -1,6 +1,6 @@
{
"name": "@elysiajs/swagger",
"version": "0.2.0",
"version": "0.3.0-beta.0",
"description": "Plugin for Elysia to auto-generate Swagger page",
"author": {
"name": "saltyAom",
@@ -33,18 +33,18 @@
"release": "npm run build && npm run test && npm publish --access public"
},
"peerDependencies": {
"elysia": ">= 0.2.0"
"elysia": ">= 0.3.0-beta.0"
},
"devDependencies": {
"@types/node": "^18.11.7",
"@types/swagger-ui-dist": "^3.30.1",
"bun-types": "^0.5.0",
"bun-types": "^0.5.7",
"eslint": "^8.26.0",
"elysia": "^0.2.0",
"typescript": "^4.9.3"
"elysia": "^0.3.0-beta.1",
"typescript": "^4.9.4"
},
"dependencies": {
"@elysiajs/static": "0.2.0",
"swagger-ui-dist": "^4.15.5"
"swagger-ui-dist": "^4.16.0"
}
}
src/index.ts
+56 -30
View File
@@ -1,20 +1,13 @@
import { type Elysia, SCHEMA, DEFS } from 'elysia'
import { getAbsoluteFSPath } from 'swagger-ui-dist'
import { staticPlugin } from '@elysiajs/static'
import type { OpenAPIV2 } from 'openapi-types'
import { getAbsoluteFSPath } from 'swagger-ui-dist'
import type { OpenAPIV3 } from 'openapi-types'
import { filterPaths, formatSwagger } from './utils'
import type { ElysiaSwaggerConfig } from './types'
const defaultConfig: Partial<OpenAPIV2.Document> = {
swagger: '2.0',
schemes: ['http', 'https'],
consumes: ['application/json', 'text/plain'],
produces: ['application/json', 'text/plain']
}
/**
* Plugin for [elysia](https://github.com/elysiajs/elysia) that auto-generate Swagger page.
*
@@ -23,12 +16,12 @@ const defaultConfig: Partial<OpenAPIV2.Document> = {
export const swagger =
<Path extends string = '/swagger'>(
{
swagger = {},
documentation = {},
excludeStaticFile = true,
path = '/swagger' as Path,
exclude = []
}: ElysiaSwaggerConfig<Path> = {
swagger: {},
documentation: {},
excludeStaticFile: true,
path: '/swagger' as Path,
exclude: []
@@ -36,8 +29,58 @@ export const swagger =
) =>
(app: Elysia) => {
app.get(path, (context) => {
context.set.redirect = `${path}/static/index.html`
return new Response(
`<!DOCTYPE HTML>
<html>
<head>
<title>Redirecting...</title>
<meta charset="utf8">
<meta http-equiv="refresh" content="0; url=${path}/static/index.html">
<script>
window.location = ${path}/static/index.html
</script>
</head>
<body>
If you're not being redirected, use this
<a href=${path}/static/index.html>
link
</a>
</body>
</html>`,
{
status: 302,
headers: {
'content-type': 'text/html; charset=utf8',
Location: `${path}/static/index.html`
}
}
)
})
.get(
`${path}/json`,
(content) =>
({
openapi: '3.0.3',
...{
...documentation,
info: {
title: 'Elysia Documentation',
description: 'Developement documentation',
version: '0.0.0',
...documentation.info
}
},
paths: filterPaths(content[SCHEMA], {
excludeStaticFile,
exclude: Array.isArray(exclude)
? exclude
: [exclude]
}),
components: {
schemas: content[DEFS]
}
} satisfies OpenAPIV3.Document)
)
.get(
`${path}/static/swagger-initializer.js`,
() =>
@@ -47,23 +90,6 @@ export const swagger =
}
})
)
.get(`${path}/json`, ({ store }) => ({
...{
...defaultConfig,
...swagger,
info: {
title: 'Elysia Documentation',
description: 'Developement documentation',
version: '0.0.0',
...swagger.info
}
},
paths: filterPaths(store[SCHEMA], {
excludeStaticFile,
exclude: Array.isArray(exclude) ? exclude : [exclude]
}),
definitions: store[DEFS]
}))
.use(
staticPlugin({
prefix: `${path}/static`,
src/types.ts
+6 -2
View File
@@ -1,4 +1,4 @@
import type { OpenAPIV2 } from "openapi-types"
import type { OpenAPIV3 } from 'openapi-types'
export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
/**
@@ -6,7 +6,11 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
*
* @see https://swagger.io/specification/v2/
*/
swagger?: Partial<OpenAPIV2.Document>
documentation?: Omit<
Partial<OpenAPIV3.Document>,
| 'x-express-openapi-additional-middleware'
| 'x-express-openapi-validation-strict'
>
/**
* Determine if Swagger should exclude static files.
*
test/index.test.ts
+1 -1
View File
@@ -3,7 +3,7 @@ import { swagger } from '../src'
import { describe, expect, it } from 'bun:test'
const req = (path: string) => new Request(path)
const req = (path: string) => new Request(`http://localhost${path}`)
describe('Swagger', () => {
it('redirect to Swagger page', async () => {