From a6b7d1f598640860ed4d72fa652e19ad5232db00 Mon Sep 17 00:00:00 2001 From: saltyaom Date: Tue, 24 Jan 2023 01:54:37 +0700 Subject: [PATCH] :tada: feat: add swagger and documentation --- bun.lockb | Bin 32104 -> 32327 bytes example/index.ts | 33 ++++++++++++++++++++++++++------- package.json | 2 +- 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/bun.lockb b/bun.lockb index bcaa0d410e4a4bcdbeb69d995adb7b5f5b2f2422..b7530c939e1d57ce5840e662fe47d485376d5cbc 100755 GIT binary patch delta 5048 zcmd5AZERE5^E-eu?7*9MS+CRk{Fn6Se7pkr0!-IF231v6GR& zsI!g0q6%ns*hD{|DwDd=s-h%CC}R^P6_gB0!&a?ggF%E!r*$1I6;jK(Zs$I~`x4t} zwf-oYCBO6T`99~Kd)_izie{-a|p=zy*Yi;6w(t_9_Am z2-9&rhV)c~2cUxHh4+t<07j4Iqa5TAnhUWI!C@l5JXglPybBV<-QZhvP` zBE*e+CR{TmE?-6&(+;6wU8>5VsT2Lo^B6XmO@=UQm~KQRJ2H;Ku|&t7b71_ zyd^Q>nX9=o$TB-0@hmb<&s5e=DSTg2LS`YorL(y^=<&mGjcNU-h+|P~Y4bFO~Xe7RoSR%(_UH0UF5o=B!_aE9QR#LgudrA+zN`$g*}CeVUK(WrSvgybf~pgv`VBvxsMWlCLl1 zaS?JJ@oXngjGWRAXje7&%pqjX5e$CXPhNlQUgSkta!rBXt=7Iu$)l~i4qa$wyc(lU z=IevOB)eW&yaD4=i+Nzss}u=p^!8MRO|}I?sm1VGQi3j`3C`#%6JCHh|7941EWxrt)@4729;P4O1&r*9G4h8N*Su>pJTf$!**bRy5yMirId=AtsHeT z*F#N?da$wh)8#!$Q)`NqGF+5*Dk08%5-ZQxRA3=zOp98nNi}NKhKkt-20^W-GuVG0 zz#y>l{dL8McBqm(R{*m^C3h&jL4+vhXZRo z=CmD0w&k+yv`vX>1>6cpQm9MeTfB3g>I5ezu#JqBiE0VSF)cyaC^fKL-oSM8D>Gu+ zFw`2YGbm4sDV>Wc(FaX!p4EA(!@c+btH;RYGsD}&+c2KT%UhSv9XXS%mRAOP-!abQ(Wmhs3}m(wGjrV7W-j*YH?%4Q0Ubzz}FkHTgm2E z!jX!?%Kw%1^F>AXz~vu4JkqvylxA#d^9|$sLhrlxC9$U~Og3aeQ-%N=o%wVf3^}vz z<~4gA`oP`>*z>k{O?h-5y6jy~SM?TGQ$pXq6% zT`XN9mXK=XWhdf=1^o{c4M>}jQYKc2HbVF$oBXG=rAx2rCN#8G;cbT;smP#JTE?@m zMiR_??5J`E`f>-x9@Nmr647cEmypvCmIQhoo{=2%Q}{q~nE6Px=f&are{X-M9(l{e z5_E=S!lSK%nU7>wpSe}~Quw8nNVi4ki^1C=!1Jw6S_L1r3Unph+e0)apX*t_?^u*S^{{3jeDxwpF+<=p9 zHZvd3a|XUw>(`C^K)(R%9s=OPPusc*rBr0{Fhi zMvGuC-j~5)yk8Di6g~+vV zIO-MXJ~-!f(}Q61IpqA<=wUeKbJLrU+hL;?sOu0Y%X^Vw33gI8kS>N7I&5Y>AiKs2 zPCv3=xQ*J&MBFDrZo)?>BVQrk@1(b&)9;{W_?=%c^O4tCJa$O<{hPC7DJzqb;1j>i z%tztPUH4Y4Ov$h#9dpVOuYnbvLOCDzg|kD3D+8~+f^?f`Wpq9+?^yA!dG*BEM-)la zybyMGI_NU^OQ)lpkIPTB>^u6~KaXG4P^P{dE1M72yOQod==kOEuTUQKiWNBCLqkBI zxv(W*lQT36P6iUG6HW)7!+LXdMX<9Iu&!8j2w|Ml<+*;Sc*E|6$Eqsyv=84$*!Pkj zBg{v5_WXsv&#i3~@wk!xZYxae~N;y<+ALyf4JZNY37H8NI{R~ zlqnyVqK>t#G>kO<@#OGlTYb0ptl5M@>()I@TUc&NF*zk9KZM@luStQ)4~BwZ4BDYOSUT5;ErNZk*kLa}PkYn9 zd|F{TvK@XFY&M8uapY^naLA_rPNUV%8iv)rvb!%Jg_?t&K({5*xQZjd67co7J^mT! P0aq|21xI|_zM%gF(@ErQ delta 4823 zcmd5;H=lvkF2okbeg$lXD{9&)fOk zJ|DR)@@tXL{J8nAc+eH86!n&h)QD7r@^+s08J&SLasv$+fJvlG(1;3b-6a~dB2B~f zn#&rgacDHvYIW20BAYY68eo^}>@|o2+q^U@!kg_OFyT|M232~yH z9@or?%^e_SRam}V^wZ(=v>SVUWDxnxZ*Q2w@2Gyo0g-1#U6%4;T(i>non3xg2O$D5 zEWvTmD;^y+w51@Dqi;HU25;s~}&Qt1nCnM@&Py7^SzM zNx7(H6|NZmR-_EC3n`2B1*EKMGAHqfYV0EIpnjQ zJQ;dJIjme)k@5&3L*K`3jrbGRe}D9%7j4OVBCT7me3gbJJhSIQbaW&76emD;I$-GV%QU$SJxy6a!AzF=pr>yJpuHZ(r9!2 zqG)rCY@RH=t(V`d)`hS`mlqXJ7A9(C1Nm*EwlYdt79^&`fg=o@hYXwor` zIu3_`HP*Khno{EeCO}XvBmN`Q>m(3C46iN_Yf(I?00 zgstN63s9qz*K362rG}fQ&Co~}m!FcsjK!V=dTkstYJZ~}2>T+|g<`&7=ps3yCSk~G zxdNx5K1(id);un;A;f+WJ22wg->Gb8Cwc$txY$ow2KlOhiX_IS)`JB4bW z5o{wiCF&}WqDV{%O~BC5Rg(CzdT;V2L?3=`q(ZH0sRr zI8Tjfoh#btgC<{|>vLtm{rCZE#>|B?BV7}hVIo&*@5DR_$oVVlg8 zRrOzmMN8MJULLQzxaA;8J^Hs3?;LtIp{`)X*n@w}oGCf-&AUrxp43c_eebD#!#Drb zS^A)VL*crguf10NQSaCf-mT0XK6JmNC^Qw~KYxa1Y;w9!+({t2GlvxH^NfE((4;Sf zZPq;c1O%-a5A&Jz1Y%%6Cs@fk1I9jEmz(T@{KgFWfAI|6Xxc*QW>~u=M4{~hhjBO$Zhu(kbDFxcLzp{sGtCJ<=!XFXO{X(}ak z$YC8mx_q#>XqexrrrXO+)g}ue(rBA}Ep_F}_Yx-+bhD`IhLwDgCPBOcj)IHl4ALC3 z+Uo1e9zMHDLARHh%w|(18HZ7xqqpD`-$3s{Qb&V9nz0VPc%u2keV3b2x7<{UU`Qr- zJ2*og9z8bmOh138?3IC6YEfJ&bZ~SMUUV2yK4bleIjHAQav2n;}dEIB{oFEX id, { schema: { + params: t.Object({ + id: t.String({ description: 'ID to get' }) + }), detail: { - deprecated: false + deprecated: true } } }) @@ -41,16 +44,32 @@ const app = new Elysia() { schema: { body: 'sign', - response: t.Object({ - username: t.String(), - password: t.String(), - id: t.String() - }) + response: { + 200: t.Object( + { + username: t.String({ + title: 'A' + }), + password: t.String(), + id: t.String() + }, + { + description: 'A', + title: 'A' + } + ), + 400: t.Object({ + error: t.String() + }) + }, + detail: { + summary: 'A' + } } } ) .get('/unpath/:id/:name', ({ params: { id } }) => id) - .post('/json', ({ body }) => '1', { + .post('/json', ({ body }) => body, { schema: { body: 'sign', response: 'sign' diff --git a/package.json b/package.json index ace1b23..4d8459c 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "@types/swagger-ui-dist": "^3.30.1", "bun-types": "^0.5.0", "eslint": "^8.26.0", - "elysia": "^0.2.0-rc.0", + "elysia": "../elysia", "typescript": "^4.9.3" }, "dependencies": {