UNPKG

@api-helper/cli

Version:

根据 Swagger 的接口定义生成 TypeScript/JavaScript 的接口类型及其请求函数代码。

68 lines (67 loc) 6.06 kB
{ "正在处理": "正 在 处 理 -> Config[%0]", "配置已加载:": "配置已加载:", "插件已经注册": "%0插件已经注册", "读取配置文件": "读取配置文件", "Config[%0]: 缺少 outputPath 配置": "Config[%0]: 缺少 outputPath 配置", "Config[%0]: 缺少 documentServers 配置": "Config[%0]: 缺少 documentServers 配置", "配置文件不存在,程序退出": "配置文件不存在,程序退出", "未选择接口文档": "未选择接口文档", "documentServers.url 不可为空!": "documentServers[%0].url 不可为空!", "没有获取或者解析到文档": "没有获取或者解析到文档", "接口文档缺少对应类型的解析插件:": "接口文档缺少对应类型的解析插件:", "文档获取与解析,这可能需要等待一段时间...": "文档获取与解析,这可能需要等待一段时间...", "代码生成,这可能需要等待一段时间...": "代码生成,这可能需要等待一段时间...", "文件输出": "文件输出", "Done. 代码生成成功.": "Done. 代码生成成功.", "已生成配置文件.": "已生成配置文件.", "配置文件生成失败.": "配置文件生成失败.", "请选择配置文件类型?": "请选择配置文件类型?", "检测到已经存在配置文件,是否覆盖已有配置文件?": "检测到已经存在配置文件,是否覆盖已有配置文件?", "更多完整配置,参考文档:": "更多完整配置,参考文档:", "outputByCategory": "使用分类输出,启用该功能后,按照接口分类进行多文件代码输出", "onlyTyping": "是否只生成接口请求数据和返回数据的 TypeScript 类型。是,则请求文件和请求函数都不会生成。", "outputPath": "代码生成后的输出路径", "target": "生成的目标代码类型。默认: typescript", "requestFunctionFilePath": "request请求工具函数文件路径。", "requiredRequestField": "请求数据所有字段设置成必有属性,默认: false", "requiredResponseField": "响应数据所有字段设置成必有属性,默认:true", "documentServers": "接口文档服务配置", "url": "文档地址【type为'swagger'类型时,可以读取本地文件,这里就可以一个本地文件路径】", "urlValue": "https://接口文档地址.com", "type": "文档类型,根据文档类型,调用内置的解析器,默认值: 'swagger'【内置yapi和swagger的解析,其他文档类型,添加parserPlugins自行实现文档解析】", "name": "当前接口文档服务名称,有值的情况下,文件输出变成 -> 路径/当前name", "dataKey": "获取响应数据的key,body[dataKey]", "auth": "访问文档可能需要认证信息,HTTP Basic Authentication", "authToken": "访问文档可能需要认证信息,通过使用token访问,yapi的验证token", "代码生成时间:": "代码生成时间:", "提示:该文件由 API Helper CLI 自动生成,请勿直接修改。": "提示:该文件由 API Helper CLI 自动生成,请勿直接修改。", "文档参考:": "文档参考:", "自定义配置": "自定义配置", "请求配置:": "请求配置:", "以axios为例的请求配置": "以axios为例的请求配置", "处理表单数据请求头": "处理表单数据请求头", "TODO 待实现具体request请求逻辑...": "TODO 待实现具体request请求逻辑...", "先用异步模拟request请求逻辑": "先用异步模拟request请求逻辑", "请求文件创建失败:": "请求文件创建失败:", "documentServers.outputFilePath 属性已经废弃,请使用 documentServers.outputPath": "documentServers.outputFilePath 属性已经废弃,请使用 documentServers.outputPath", "documentServers.output 属性已经废弃,请使用 documentServers.outputPath": "documentServers.output 属性已经废弃,请使用 documentServers.outputPath", "没有获取到swagger配置文档:documentServers[%0].url -> ": "没有获取到swagger配置文档:documentServers[%0].url -> ", "解析swagger配置失败:documentServers[%0].url -> ": "解析swagger配置失败:documentServers[%0].url -> ", "swagger文件读取失败:": "swagger文件读取失败:", "获取项目基本信息失败:": "获取项目基本信息失败:", "获取菜单列表失败:": "获取菜单列表失败:", "获取接口列表数据失败:": "获取接口列表数据失败:", "项目接口为空:": "项目接口为空:", "接口详情获取失败:": "接口详情获取失败:", "解析yapi配置失败:": "解析yapi配置失败:", "初始化配置": "初始化配置", "API生成工具": "API生成工具", "自定义配置文件路径": "自定义配置文件路径", "接口文档地址【当type为'swagger'类型时,可以读取本地文件,这里就可以一个本地文件路径】": "接口文档地址【当type为'swagger'类型时,可以读取本地文件,这里就可以一个本地文件路径】", "代码生成后的输出路径": "代码生成后的输出路径", "生成的目标代码类型,默认: typescript": "生成的目标代码类型,默认: typescript", "文档类型,根据文档类型,调用内置的解析器,默认值: 'swagger'": "文档类型,根据文档类型,调用内置的解析器,默认值: 'swagger'", "访问文档可能需要认证信息,通过使用token访问,yapi的验证token": "访问文档可能需要认证信息,通过使用token访问,yapi的验证token", "帮助信息": "\n详细命令说明:\n初始化配置文件: apih init\n初始化配置文件(指定配置文件路径): apih init -c 路径/配置文件.ts\n生成代码: apih\n生成代码(指定配置文件): apih -c 路径/配置文件.ts\n查看帮助: apih -h\n\n# GitHub\nhttps://github.com/ztz2/api-helper\n" }