swagger-to-api README

添加默认配置文件

• vscode命令行Ctrl+Shift+P => 输入选择 添加swagger默认配置文件，创建默认配置文件swaggerToApiConfig.cjs

• 或手动添加配置文件也可，支持swaggerToApiConfig.json swaggerToApiConfig.js 文件名称

• js以及cjs请使用commonjs规范!

配置文件说明

配置文件格式如下

{
    "swaggerUrls": [
        {
            "name": "ORG",
            "url": "http://10.0.0.4:8033/ZYKP_OrgApp/swagger/docs/v1", //url和input 二选一
            "input": "./swagger.json", //同上说明，input用于本地json生成
            "swagger": "2.0",
            "options":{}  //可选 单个
        }
    ],
    "options":{}  //可选 整体
}

• swaggerUrls: 必选字段.

• name: 添加API名称，保持唯一.

• url: swagger地址.

• input: swagger json文件本地相对路径.

• swagger: swagger版本号，可选参数为 2.0 | 3.0， 不填默认为2.0.

• options: 会作为参数传入generateApi，覆盖默认参数. 单个item配置高于 整体优先级

• 完成配置后使用右键 转换Swagger到API

• 快捷键 ctrl+shift+t or cmd+shift+t

• vscode命令行Ctrl+Shift+P => 输入选择 转换Swagger到API

• 任意指令完成API转换

高级功能

• 根目录下创建 swaggerToApiTemplates 文件夹 将对应模板文件放入其中

• 或vscode命令行Ctrl+Shift+P => 输入选择 添加swagger转换模板

• 详细模板文件参考swagger-typescript-api官方文档

• 创建后转换时会自动读取项目下模板文件进行转换

附加功能

• workspaceFolder 字段支持全路径输出转换路径