通过OpenAPI和Visual Studio生成客户端代码

最新推荐文章于 2025-03-31 10:08:54 发布

zLulus

最新推荐文章于 2025-03-31 10:08:54 发布

阅读量722

点赞数

文章标签： c# microsoft

本文链接：https://blog.youkuaiyun.com/sinat_23050697/article/details/130427719

版权

本文介绍了如何利用Visual Studio的Connected Services功能，从OpenAPI（Swagger）文档自动生成HTTP API客户端代码。通过连接本地或在线的swagger文档，可以便捷地创建并更新客户端项目，简化API调用。示例中详细展示了设置过程和生成的代码使用方式。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

根据Generating HTTP API clients using Visual Studio Connected Services，我们得知，我们可以通过Visual Studio连接API，进而自动生成对应的客户端代码。

首先，我们启动一个本地服务DotNet6WebAPI。代码可以参考这里。

这里我们获得了一个API地址：http://localhost:5137/swagger/index.html。
它的schema地址为http://localhost:5137/swagger/v1/swagger.json。这个地址是我们后面需要用到的地址。

然后我们创建一个客户端项目DotNet6WebAPI.Client。
通过Visual Studio创建一个客户端代码：
右键项目，添加连接服务。

点击加号添加连接服务。这里支持的服务有OpenAPI、gPRC和WCF服务。

这里我们可以选择一个swagger.json文件，也可以输入一个可访问的在线swagger文档。

生成成功。

接着我们就可以正常使用它了：

using TestClientNamespace;

HttpClient httpClient = new HttpClient();
TestClient client = new TestClient("http://localhost:5137/", httpClient);
var enums = await client.GetEnumAsync();
Console.WriteLine(enums);

这里我们访问GetEnum接口，只需要调用相应的GetEnumAsync方法即可。如果存在参数，则方法会列出参数列表。
返回结果如下&