给koa2项目加入swagger文档

822 阅读1分钟

创建一个koa2项目

项目创建请看我前一篇文章:基于ts与es6语法的koa2项目创建

安装依赖

pnpm i @types/swagger-jsdoc -D
pnpm i @ykmmky/koa2-swagger-ui swagger-jsdoc

本来应该安装pnpm i koa2-swagger-ui, 但koa2-swagger-ui中使用的swagger ui的cdn,在我使用的网络,几乎不可访问。因此改为了使用@ykmmky/koa2-swagger-ui,可对使用的swagger ui的cdn资源进行配置

资源cdn

www.bootcdn.cn/swagger-ui/

参考文章

koa API文档 使用Swagger

node从入门到放弃系列之(8)koa2 swaggerUI的使用