Swagger-TS 使用指南

Swagger-TS 使用指南

swagger-ts 把swagger接口转换成ts的工具 项目地址: https://gitcode.com/gh_mirrors/sw/swagger-ts

项目目录结构及介绍

Swagger-TS 是一个致力于将 Swagger 接口描述转换为 TypeScript 类型定义和请求模块的工具，简化了前后端分离项目中接口类型的管理和维护工作。以下是典型的项目生成后的目录结构示例：

├── test-api            # 自动生成的特定API目录
│   ├── swagger-api     # 包含请求相关的.ts文件
│       └── index.ts    # 请求函数入口
│   ├── swagger-utils   # 包含请求参数和响应参数的类型声明及接口定义
│       └── index.ts    # 类型和接口定义
│   ├── main.ts         # 入口文件，便于集成或测试
│   ├── package.json    # 控制API版本，备用配置
│   ├── npmignore       # 指定npm包发布的排除项
│   ├── README.md       # API使用介绍
│
├── ...                 # 其它可能由用户自定义或根据需求生成的目录结构

注意：此结构为Swagger-TS生成API后的典型布局，并非原始仓库的结构。原始仓库主要是Node.js项目，包含源码、文档和脚本等。

项目的启动文件介绍

Swagger-TS本身并不直接提供一个传统的“启动文件”，而是通过命令行工具交互。主要通过npm脚本或者直接调用命令来生成TypeScript代码。例如，执行以下命令来添加或更新API：

# 添加API到指定目录，并准备发布到npm（需登录）
swagger-ts -a

# 或者仅在本地生成，不涉及npm发布
swagger-ts -a nopublish

若要模拟一个“启动流程”，那便是运行这些命令来生成或更新你的TypeScript接口文件，随后在前端项目中import这些文件来使用。

项目的配置文件介绍

Swagger-TS并未直接提供一个内部配置文件模板作为项目的一部分。其配置和操作主要是通过命令行参数来实现的。不过，你可以在项目的根目录下自定义脚本来间接配置，比如在package.json中添加脚本指令：

{
  "scripts": {
    "generate-swagger": "swagger-ts -a nopublish"
  }
}

这样一来，通过npm run generate-swagger即可执行生成逻辑，达到了配置的效果。

此外，对于Swagger API的地址、生成的API命名等，是在命令行交互时动态提供的，而非通过静态配置文件设定。

总结，Swagger-TS的重点在于通过命令行工具快速转化Swagger接口为TypeScript定义，更多依赖于用户的命令行输入和潜在的外部项目管理（如npm脚本、Git版本控制）来实现项目的定制和维护，而不是内置复杂的配置体系。

swagger-ts 把swagger接口转换成ts的工具 项目地址: https://gitcode.com/gh_mirrors/sw/swagger-ts