在TypeScript中创build一个Swagger Web服务的正确方法是什么?
我是用TypeScipt编写的项目的一部分,我正在尝试添加将与Swagger兼容的TypeScript Web服务器。
考虑到易维护性,实施它的最基本的策略是什么。
-
对于Typescript,我注意到存在用于从TypeScript接口生成JSON模型的“Typson”库。
-
对于Swagger,我曾尝试使用'swagger-node-restify'库,因为它支持将JSON模型添加到swagger中。
但是,我遇到一些问题:
- Typson不支持导入的 typeScript 语法 – (
import {Server} from "restify"
) - 我试图实现'swagger-node-restify'示例(Pet Example),但localhost:8080 / api-docs.json GET请求的RESPONSE缺lessAPI的所有SPEC数据。
{"apiVersion":"0.1","swaggerVersion":"1.1","basePath":"http://localhost:8080","apis":[{"path":"/api-docs.{format}/pet","description":"none"}]}
我build议使用yaml
或json
来描述符合Swagger的API,并从中生成服务器 。
swagger-server可以在express
上实时生成API(无源代码生成)。
有JavaScript
代码生成器 :
-
用
-l nodejs-server
调用swagger--l nodejs-server
客户端 -
swagger-node是一个很好的select,但似乎很难与
TypeScript
整合