midway-swagger
OpenAPI(Swagger)规范是一种用于描述 RESTful API 的强大定义格式。 midway-swagger 提供了声明式的 api 及参数验证。
快速开始
npm i midway-init -g
midway-init --package=midway-swagger
进入项目目录
yarn
yarn dev
查看 swagger ui
访问: http://127.0.0.1:7001/swagger-ui
配置 swagger (open api)
进入 src/app.ts
/** * open api 文档配置 */document .setTitle'midway openApi' .setVersionprocess.env.npm_package_version .setDescription'支持基于 interface 的验证' // api 认证方式 .setSecuritySchemes
配置 swagger ui
进入 src/app.ts
await openApiapp,
声明 API
路由参数
在路由处理程序中查找所有使用的
@Body()
, @Query()
和 @Param()
等装饰器来生成 API 文档。该模块利用反射创建相应的模型定义。