express-joi-to-swagger:从源代码生成swagger API文档的简单工具

时间:2024-04-27 21:59:15
【文件属性】:

文件名称:express-joi-to-swagger:从源代码生成swagger API文档的简单工具

文件大小:204KB

文件格式:ZIP

更新时间:2024-04-27 21:59:15

TypeScript

欢迎速递 描述 通过代码生成漂亮的Swagger API文档的解决方案。 :laptop: 它列出了在内注册的所有端点及其路由,和相关中间件。 当涉及到生成 :bookmark_tabs: Swagger文档,您有两个选择。 生成可在您的应用程序中用作静态文件的 ,或将文档作为data.json文件保存在已定义的内部 :file_folder: 地点。 有关更多信息,请参见下面的配置参数 :down_arrow: 。 这个简单的工具不需要您编写更多必要的代码。 文档是从源代码本身生成的,而无需使用批注或单独的doc文件。 安装 使用软件包管理器( npm或yarn )来安装依赖项。 npm install @goodrequest/express-joi-to-swagger or yarn add @goodrequest/express-joi-to-swagger 要求 :multiply: 该解决方案适用于将与结合使用以构建应用程序API的每个人。 此版本是在Joi的17


【文件预览】:
express-joi-to-swagger-master
----tsconfig.build.json(400B)
----.eslintrc(2KB)
----src()
--------utils()
--------ui()
--------index.ts(1010B)
--------baseSwagger.ts(7KB)
--------func-loc()
--------parser.ts(12KB)
----demo()
--------app.ts(143B)
--------index.ts(729B)
--------outputSwagger.json(2KB)
--------output-example.png(197KB)
--------samples()
--------middlewares()
--------endpoints()
----tsconfig.json(398B)
----jest.config.js(169B)
----README.md(9KB)
----.lintstagedrc(69B)
----.huskyrc(52B)
----.npmrc(26B)
----.editorconfig(303B)
----tests()
--------parser.test.ts(88B)
----.gitignore(103B)
----package.json(2KB)

网友评论