.NET Core添加OpenApi服务引用时如何自动生成客户端接口
OpenApi客户端自动生成接口的实现方案
配置逻辑
Visual Studio内置的OpenApi连接服务底层基于NSwag引擎生成代码,默认未开启接口生成开关,无需更换工具链,仅调整生成配置即可实现接口和客户端的同步生成,完全替代手动维护接口的模式。
具体操作步骤
- 定位项目目录下的
ConnectedServices文件夹,找到对应OpenApi服务的配置文件(后缀为.connected.json,与你设置的客户端类名一一对应) - 打开配置文件,在NSwag代码生成的配置节点中添加
GenerateClientInterfaces: true参数,保存后右键对应服务引用选择「更新服务引用」
配置参考片段:{ "ProviderId": "Microsoft.VisualStudio.ConnectedService.OpenApi", "CodeGenerators": [ { "Name": "NSwag", "Settings": { "GenerateClientClasses": true, "GenerateClientInterfaces": true, "ClientClassAccessModifier": "public" } } ] } - 生成完成后,工具会自动输出匹配的接口,命名规则为
I{你自定义的客户端类名},例如原生成的MyTestApiClient会同步生成对应的IMyTestApiClient接口,接口方法会和Swagger定义的端点、参数、返回值完全对齐。WebApi更新后只需要执行「更新服务引用」即可同步接口定义,无额外维护成本。
依赖注入优化
生成带接口的客户端后,可直接使用.NET内置的HttpClient工厂完成注册,无需手动编写委托逻辑:
- 项目引入
Microsoft.Extensions.HttpNuGet包 - 在
Startup.cs或Program.cs中添加注册代码:
该方式自动管理HttpClient的生命周期,避免手动实例化带来的Socket耗尽问题,同时天然支持单元测试时的接口mock。services.AddHttpClient<IMyTestApiClient, MyTestApiClient>(client => { client.BaseAddress = new Uri("https://localhost:5001"); });
常见问题处理
- 如果更新服务引用后配置被重置,可直接将生成参数写入项目的
.csproj文件,将NSwag的固定参数和项目文件绑定,避免VS配置面板重置自定义设置 - 生成的接口不会影响原有的partial类扩展逻辑,你之前为客户端类添加的自定义扩展可以正常和生成的接口共存
- 如果使用.NET 8内置的OpenApi客户端生成器(即通过
<OpenApiReference>在csproj中配置的服务引用),可在引用节点添加InterfaceGenerator="Standard"参数,同样可实现自动生成接口的效果。
内容的提问来源于stack exchange,提问作者john.acb
相关产品推荐
相关产品推荐

