【文件属性】:
文件名称:egg-swagger-doc:eggjs-swagger-doc Eggjs + egg-swagger-doc 生成RESTFUL 接口
文件大小:92KB
文件格式:ZIP
更新时间:2021-05-17 00:14:32
TypeScript
egg-swagger-ui 配置
前言
Eggjs 是阿里巴巴团队开发的,一个基于 Koajs 的框架,相当于二次封装,相比较 Koajs ,并没有那么高的*度,但 Eggjs 这种带有规范性的开发更适合在企业中使用。
Swagger 是 RESTFUL 接口的文档在线自动生成工具。
此文档基于Eggjs + egg-swagger-doc 生成RESTFUL 接口供调试使用。
环境准备
操作系统:支持 macOS,Linux,Windows
运行环境:建议选择 LTS 版本,最低要求 8.x。
本文制作时对应eggjs版本: 2.27.0
目录结构
${APP}
├─.vscode
├─app
│ ├─contract // 存放对应type参数为body formData的传参值
│ ├─request // 请求参数
│ │ └─ user.ts
│
【文件预览】:
egg-swagger-doc-master
----.gitignore(207B)
----app()
--------entity()
--------controller()
--------contract()
--------service()
--------index.ts(978B)
--------router.ts(343B)
----.eslintrc(106B)
----package.json(2KB)
----.autod.conf.js(351B)
----package-lock.json(421KB)
----.travis.yml(171B)
----tsconfig.json(717B)
----.github()
--------workflows()
----README.md(9KB)
----config()
--------plugin.ts(409B)
--------config.prod.ts(143B)
--------config.default.ts(3KB)
--------config.local.ts(143B)
----.eslintignore(24B)
----appveyor.yml(241B)
----typings()
--------app()
--------config()
--------index.d.ts(40B)
----test()
--------app()