繁体   English   中英

如何从 OpenAPI 3.0 规范生成 Express + TypeScript API?

[英]How to generate an Express + TypeScript API from OpenAPI 3.0 specification?

我使用 OpenAPI 3.0 为我的 REST API 服务器编写了规范。 现在,与其手动编写大量重复的代码,还有可能引入的所有错误,我想快速生成一个 expressjs 应用程序。 我知道我可以从editor.swagger.io生成一个服务器应用程序,但是生成的代码是 javascript,所以我不能使用我的模型中的类型!

有没有一种工具可以根据 OpenAPI 3.0 规范生成用 typescript 编写的快速应用程序? 如果它可以创建所有文件夹、控制器并正确使用模型(以标准方式!),那就太棒了。 那肯定会很快开始我的项目!

swagger-node- codegen 允许从 OpenAPI yaml 或 json 文件生成 expressjs 服务器。

以下命令:

snc schema.yml  -o ./my-api

如果您的规范中有示例,将生成带有模拟数据的 REST API 框架。 然后,您可以添加您的业务逻辑。

它具有以下特点:

  • ES7
  • ESLint
  • YAML 配置文件
  • 表达

唯一的问题是,它不会在带有模型的 TypeScript 中生成代码。 但是模型可以很容易地集成到代码中。 使用“tsc”升级代码 Typescript 并将所有 .js 文件重命名为 .ts 即可完成这项工作。

可以看看以下2个地方:

  • openapi.tools :所有 OpenAPI 工具的一站式集合,包括相当多的服务器代码生成工具;
  • OpenAPI Codegen 官方:有类似 nodejs-express-codegen(beta) 的东西。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM