Skip to content

axetroy/swagger2ts

Repository files navigation

中文简体 | English

Build Status

从 swagger(v3) 的 JSON 文件生成 typescript 代码。

它会生成 typescript 的声明和基于 fetch 的运行时。几乎开箱即用。

它能够适用于绝大多数场景,强健你的接口调用,省去烦人的类型声明。

这里有一些生成好的精美例子,看看是否符合您的胃口

安装

通过 Deno 安装

deno install \
  -A \
  --no-check \
  --reload \
  -f \
  https://github.com/axetroy/swagger2ts/raw/v0.2.26/swagger2ts.ts

或者通过 npm 安装

npm install -g @axetroy/swagger2ts

使用

使用命令行工具

swagger2ts swagger.json > api.ts
swagger2ts https://example.com/swagger.json > api.ts

通过 nodejs 函数调用

import { generate } from "@axetroy/swagger2ts";

const output = await generate("/path/to/swagger.json");
// const output = await generate("https://example.com/swagger.json");

console.log(output);

通过 Deno 函数调用

import { generate } from "https://github.com/axetroy/swagger2ts/raw/v0.2.26/generate.ts";

const output = await generate("/path/to/swagger.json");
// const output = await generate("https://example.com/swagger.json");

console.log(output);

开源许可

The MIT License

About

💗 从 Swagger 生成优雅的 Typescript 代码. Generate elegant typescript code from swagger.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages