如何通过NSwagStudio配置为生成的TypeScript客户端添加自定义导入及头部代码
实现方法
完全可以通过NSwagStudio内置配置实现该需求,无需额外编写后处理脚本修改生成文件,操作步骤如下:
- 打开你正在使用的NSwagStudio配置(.nswag文件),切换到TypeScript Client配置标签页
- 在配置分类中找到「Code Generation Settings」下的
Extension Code(部分汉化版本显示为「扩展代码」,对应配置项名为extensionCode)输入框 - 将你需要添加的头部代码完整粘贴到该输入框中:
// eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-nocheck import { BaseClient } from 'my-components-lib';
- 继续在当前标签页找到
Client Base Class(客户端基类)配置项,填入BaseClient,后续生成的所有客户端类都会自动继承该基类,无需手动修改生成的类定义 - 点击「Generate Files」重新生成代码即可,你添加的自定义代码会自动放在所有生成内容的最顶部
如果你是直接维护nswag.json配置文件,也可以直接在codeGenerators.openApiToTypeScriptClient节点下新增对应配置字段,示例片段如下:
{ "codeGenerators": { "openApiToTypeScriptClient": { "extensionCode": "// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-nocheck\nimport { BaseClient } from 'my-components-lib';", "clientBaseClass": "BaseClient" } } }
如果使用旧版本NSwagStudio找不到对应配置项,可以直接在配置搜索框输入extensionCode快速定位
内容的提问来源于stack exchange,提问作者SNO
相关产品推荐
相关产品推荐

