node.js - 在 TypeScript 中创建 swagger web 服务的正确方法是什么

标签 node.js typescript swagger

我是一个用 TypeScipt 编写的项目的一部分,我正在尝试添加与 Swagger 兼容的 TypeScript Web 服务器。
考虑到易维护性,实现它的最基本策略是什么。

  • 对于 Typescript,我注意到存在用于从 TypeScript 接口(interface)生成 JSON 模型的“Typson”库。

  • 对于 Swagger,我尝试使用“swagger-node-restify”库,因为它支持将 JSON 模型添加到 swagger。

但是,我遇到了一些问题:

  1. Typson 不支持 typeScript Import 语法 - (从“restify”导入 {Server})
  2. 我尝试实现“swagger-node-restify”示例(Pet 示例),但是 localhost:8080/api-docs.json GET 请求的响应缺少 API 的所有 SPEC 数据。 {"apiVersion":"0.1","swaggerVersion":"1.1","basePath":"http://localhost:8080","apis":[{"path":"/api-docs. {format}/pet","description":"none"}]}

最佳答案

我建议使用 yamljson 描述一个 Swagger 兼容的 API 并从中生成服务器 .

swagger-server可以在 express 上实时构建 API(无需生成源代码)。

JavaScript代码生成器:

  • -l nodejs-server调用swagger-codegen客户端

  • swagger-node是一个很好的选择,但似乎很难与 TypeScript

  • 集成

关于node.js - 在 TypeScript 中创建 swagger web 服务的正确方法是什么,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/35839784/

相关文章:

node.js - 如何设置字段的默认值以从 Sequelize.js 中的另一个字段返回值

javascript - 导出默认的新对象

javascript - 如何将新日期列填充到现有 CSV 文件

java - OpenAPI/Swagger 构建具有多个相同键的对象

mysql - NodeJS + MySql : Is this code correct for multiple select queries since they are asyncronous

visual-studio-2012 - 如何在 Visual Studio 中显示 TypeScript 类大纲

typescript - 为什么非空断言运算符(!)不向生成的 JS 发出实际的非空和非未定义检查

html - 为行值添加条件( Angular Material )

spring - Swagger 从属性文件中读取文档

swagger - 如何根据 http 方法要求字段?