如何从Swagger架构生成基本的TypeScript接口？

Question

我正在寻找一种从Swagger架构生成简单TypeScript接口的方法。我发现的大多数解决方案都是不必要的复杂。

我想生成这样的接口：

export interface IBar {
    a?: string;
    b: number;
    c: Date;
    baz?: IBaz;
}

export interface IBaz {
    d: number;
    color: Color;
}

export enum Color {
    RED = 0,
    GREEN = 1,
    BLUE = 2,
}

从这样的架构：

    {
  "x-generator": "NSwag v11.14.0.0 (NJsonSchema v9.10.24.0 (Newtonsoft.Json v9.0.0.0))",
  "swagger": "2.0",
  "info": {
    "title": "",
    "version": ""
  },
  "schemes": [],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/api/Foo/GetBarDescriptions": {
      "get": {
        "tags": [
          "Foo"
        ],
        "operationId": "Foo_GetBarDescriptions",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "x-nullable": true
          }
        }
      }
    },
    "/api/Foo/GetBar": {
      "get": {
        "tags": [
          "Foo"
        ],
        "operationId": "Foo_GetBar",
        "parameters": [
          {
            "type": "integer",
            "name": "id",
            "in": "query",
            "required": true,
            "x-nullable": false,
            "format": "int32"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/Bar"
            },
            "x-nullable": true
          }
        }
      }
    },
    "/api/Foo/SetBar": {
      "post": {
        "tags": [
          "Foo"
        ],
        "operationId": "Foo_SetBar",
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Bar"
            },
            "x-nullable": true
          }
        ],
        "responses": {
          "204": {
            "description": ""
          }
        }
      }
    }
  },
  "definitions": {
    "Bar": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "B",
        "C"
      ],
      "properties": {
        "A": {
          "type": "string"
        },
        "B": {
          "type": "integer",
          "format": "int32"
        },
        "C": {
          "type": "string",
          "format": "date-time"
        },
        "Baz": {
          "$ref": "#/definitions/Baz"
        }
      }
    },
    "Baz": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "D",
        "Color"
      ],
      "properties": {
        "D": {
          "type": "number",
          "format": "decimal"
        },
        "Color": {
          "$ref": "#/definitions/Color"
        }
      }
    },
    "Color": {
      "type": "integer",
      "description": "",
      "x-enumNames": [
        "RED",
        "GREEN",
        "BLUE"
      ],
      "enum": [
        0,
        1,
        2
      ]
    }
  },
  "parameters": {},
  "responses": {},
  "securityDefinitions": {}
}

Answer 1

不确定这是否是一种理智的方式，这是我第一次玩Swagger。

我碰到了以下链接并粘贴了我整合的项目中的模式。从顶部的“生成客户端”菜单中，我选择了一个TypeScript预设，它生成了一个最小的项目，我可以在其中提取我需要的位，接口和类等。

http://editor.swagger.io/#/

我尝试运行你的架构。以下是生成代码的一小段摘录：

export interface Bar {
    "a"?: string;
    "b": number;
    "c": Date;
    "baz"?: Baz;
}

export interface Baz {
    "d": number;
    "color": Color;
}

/**
 * 
 */
export type Color = "0" | "1" | "2";

也许经过一些调整，它可以完全满足您的需求。

进一步阅读可能是关于像https://github.com/swagger-api/swagger-codegen这样的工具，但在线网络编辑器是一种快速而肮脏的方式来做到这一点。

Answer 2

您还可以查看autorest.typescript客户端代码生成器。它为所有模型定义提供了良好的接口，准确定义了只读属性和枚举。它支持一堆custom extensions，可用于改善生成的客户端的用户体验。你可以看看一些生成的sample clients。

额外：生成的typescript客户端在node.js中运行，也可以在webpack的帮助下在浏览器中运行。

Answer 3

您可以尝试使用此工具sw2dts，它生成如下代码：

export interface Bar {
    A?: string;
    B: number; // int32
    C: string; // date-time
    Baz?: Baz;
}
export interface Baz {
    D: number; // decimal
    Color: Color;
}
/**
 * 
 */
export type Color = 0 | 1 | 2;

Color enum似乎需要一些调整，它应该包含迭代的属性名称，而不是实数。

Answer 4

您还可以使用简单的json到typescript转换器http://json2ts.com/从每个模式生成每个接口。它不是完全自动化的，但总比没有好......而且很简单。

Answer 5

我使用dtsgen，它在我的情况下运作良好。

yarn dtsgen --out ./path/to/generated-types.d.ts ./path/to/input/swagger.json.or.yml

Answer 6

灵感来自https://stackoverflow.com/a/43513850/4948492：

Swagger Codegen为各种语言和框架生成服务器存根和客户端SDK，包括Node.js.

要生成Node.js服务器存根，请使用-l nodejs-server参数运行codegen。

示例（Mac）：

swagger-codegen generate -l typescript-angular -i swagger.yaml -o ~/Downloads/ts-test