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

🎉 feat: 0.3

Browse Source
This commit is contained in:
saltyaom
2023-03-17 18:33:45 +07:00
parent 6b5ae8ddd5
commit 8fa26e6a72
6 changed files with 823 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
example/index.ts
+3 -106
View File
@@ -1,5 +1,6 @@
import { Elysia, t, SCHEMA } from 'elysia'
import swagger from '../src/index'
import { swagger } from '../src/index'
import { plugin } from './plugin'
const app = new Elysia()
.use(
@@ -18,109 +19,5 @@ const app = new Elysia()
}
})
)
.setModel({
sign: t.Object(
{
username: t.String(),
password: t.String()
},
{
description: 'Models for handling authentication'
}
),
number: t.Number()
})
.get('/', ({ set }) => 'hi', {
schema: {
detail: {
summary: 'Ping Pong',
description: 'Lorem Ipsum Dolar',
tags: ['Test']
}
}
})
.get('/unpath/:id', ({ params: { id } }) => id, {
schema: {
params: t.Object({
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 } }) => ({
...body,
id
}),
{
transform({ params }) {
params.id = +params.id
},
schema: {
body: 'sign',
params: t.Object({
id: t.Number()
}),
response: {
200: t.Object(
{
id: t.Number(),
username: t.String(),
password: t.String()
},
{
title: 'User',
description: "Contains user's confidential metadata"
}
),
400: t.Object({
error: t.String()
})
},
detail: {
summary: 'Transform path parameter'
}
}
}
)
.post('/file', ({ body: { file } }) => file, {
schema: {
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()
}
})
.use(plugin)
.listen(8080)
example/plugin.ts
+114
View File
@@ -0,0 +1,114 @@
import { Elysia, t } from 'elysia'
export const plugin = (app: Elysia) =>
app.group(
'/a',
(app) =>
app
.setModel({
sign: t.Object(
{
username: t.String(),
password: t.String()
},
{
description: 'Models for handling authentication'
}
),
number: t.Number()
})
.get('/', ({ set }) => 'hi', {
schema: {
detail: {
summary: 'Ping Pong',
description: 'Lorem Ipsum Dolar',
tags: ['Test']
}
}
})
.get('/unpath/:id', ({ params: { id } }) => id, {
schema: {
params: t.Object({
id: t.String({
description: 'Extract value from path parameter'
})
}),
detail: {
deprecated: true
}
}
})
.post('/json', ({ body }) => body, {
schema: {
contentType: 'application/json',
body: 'sign',
response: {
200: 'sign'
},
detail: {
summary: 'Using reference model'
}
}
})
// .post(
// '/json/:id',
// ({ body, params: { id }, query: { name } }) => ({
// ...body,
// id
// }),
// {
// transform({ params }) {
// params.id = +params.id
// },
// schema: {
// body: 'sign',
// params: t.Object({
// id: t.Number()
// }),
// response: {
// 200: t.Object(
// {
// id: t.Number(),
// username: t.String(),
// password: t.String()
// },
// {
// title: 'User',
// description:
// "Contains user's confidential metadata"
// }
// ),
// 400: t.Object({
// error: t.String()
// })
// },
// detail: {
// summary: 'Transform path parameter'
// }
// }
// }
// )
.post('/file', ({ body: { file } }) => file, {
schema: {
body: t.Object({
file: t.File({
type: ['image/jpeg', 'image/'],
minSize: '1k',
'maxSize': '5m'
})
}),
response: t.File()
}
})
// .post('/files', ({ body: { files } }) => files[0], {
// schema: {
// body: t.Object({
// files: t.Files({
// type: 'image',
// maxSize: '5m'
// })
// }),
// response: t.File()
// }
// })
)