我是一个用 TypeScipt 编写的项目的一部分,我正在尝试添加与 Swagger 兼容的 TypeScript Web 服务器。
考虑到易维护性,实现它的最基本策略是什么。
对于 Typescript,我注意到存在用于从 TypeScript 接口(interface)生成 JSON 模型的“Typson”库。
对于 Swagger,我尝试使用“swagger-node-restify”库,因为它支持将 JSON 模型添加到 swagger。
但是,我遇到了一些问题:
- Typson 不支持 typeScript Import 语法 -
(
从“restify”导入 {Server}
) - 我尝试实现“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"}]}
最佳答案
我建议使用 yaml
或 json
描述一个 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/