ඔබගේ TypeScript පරිඝණක ව්යාපෘතියට OpenAPI (Swagger) ලේඛන අවශ්යද? දැන් framework එකක් භාවිතා නොකර, ඔබේ පවතින වර්ගයන්ගෙන්ම ස්වයංක්රීයව ලේඛන සාදන නව npm පැකේජයක් – Autoswag – වෙයි.
Autoswag නවතම JSDoc ටැග් @autoswag භාවිතා කර ඔබේ route විස්තරය ලියන අතර, @accept සහ @response වල සඳහන් TypeScript වර්ගයන් ගතකර ඒවා OpenAPI schema බවට පරිවර්තනය කරයි. මෙයින් ඔබට වරක් වරක් එකම වර්ගයන් දෙවරක් ලියන අවශ්යතාවය නැතිවේ. Zod schema පවා මෙය හඳුනාගනිමින්, comments තුළ දී ඇති metadata (උදා: @example, @format) නිරවද්යව Swagger ලේඛනයේ ඇතුළත් කරයි.
මෙම මෙවලම runtime එකේ කිසිදු dependency එකක් එක් නොකරයි; එය පූර්ණයෙන්ම build time එකේ ක්රියා කරයි. ඒ නිසා Express, Koa, Fastify, හෝ සරල vanilla JavaScript වැනි ඕනෑම framework එකක සමඟ භාවිතා කළ හැකි අතර, ඔබේ කේත සැලැස්මට කිසිදු සීමාවක් නොමැත.
ශ්රී ලංකාවට ඇති වැදගත්කම
ශ්රී ලංකාවේ තාක්ෂණික ශිෂ්යයන්, නිර්මාතෘවරු හා ව්යාපාරිකයින්ට මෙය විශාල වාසියක් ගෙනදේ. මුලින්ම, TypeScript වර්ගයන්ගෙන්ම Swagger ලේඛන සාදීම නිසා ලේඛන නිර්මාණය සඳහා වෙන් කරන කාලය අඩු වේ, ඉතින් වැඩි නිෂ්පාදන කාලයක් ලබා ගත හැක. දෙවනුව, framework‑අනුව සීමා නොවන නිසා දැනට භාවිතා කරන Node.js පරිසරය 그대로 රැගෙන යා හැකි වන අතර, නවතම Zod validation library සමඟ ඒකාබද්ධ වීමෙන් data validation සහ documentation එකම තැනින් කළ හැක. තෙවනුව, open‑source GitHub repository එකේ ඇති issue tracker සහ PR ක්රමය මඟින් ප්රාදේශීය සංවර්ධකයන්ට කේතයට දායක වීමට, දැනුම බෙදා ගැනීමට සහ තාක්ෂණික සමාජය ශක්තිමත් කිරීමට අවස්ථාව ලැබේ.
Autoswag භාවිතා කිරීම ඉතා සරල – ඔබේ ව්යාපෘතියේ devDependency එකක් ලෙස npm install -D autoswag ක්රමයෙන් එක් කර, npm script එකක් හරහා ලේඛන ජනනය කරන්න. ලේඛන සකස් කිරීමේ අධික පරිශ්රම නැතිව, API consumers සඳහා නවීන, නිවැරදි Swagger UI එකක් ලබාදීමේ අරමුණ ඉටු කරයි.
ඔබගේ පළපුරුද්ද Autoswag සමඟ පරීක්ෂා කර, ලේඛන නිර්මාණයේ අධික බරක් අඩු කර, වැඩි කාර්යක්ෂමතාවක් අත්විඳින්න.
