位置：首页-资讯-后端开发

ASP.NET Core中引用OpenAPI服务的添加示例

2024-04-02 19:55

短信预约 -IT技能 免费直播动态提醒

前言：

本文使用 .NET Core SDK 3.1 的版本。

在我们使用微服务的时候，各个微服务之间会经常调用接口，但是手动写Http请求的代码非常繁琐，在 Visual Studio 2019 的 .NET Core 项目中提供了添加连接的服务的功能，使得我们的工作变得简单容易。

一、将 Swagger 引入 WebAPI 项目

将 Swagger 引入 ASP.NET Core 项目可以使用Swashbuckle 和 ASP.NET Core 入门这篇微软官方文档。

创建一个 ASP.NET Core Web API 服务
执行以下命令引入对应的包：

	Install-Package Swashbuckle.AspNetCore -Version 5.6.3

将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中：

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services.AddSwaggerGen();
    }

在 Startup.Configure 方法中，启用中间件为生成的 JSON 文档和 Swagger UI 提供服务：

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        app.UseSwagger();
        app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"));
        app.UseRouting();
        app.UseEndpoints(endpoints => endpoints.MapControllers());
    }

配置完成后启动项目访问 Swagger 页面，

点击页面上的 /swagger/v1/swagger.json 即可跳转到我们的URL，

例如我这里的是：http://localhost:5000/swagger/v1/swagger.json

二、添加 OpenAPI 服务引用

在解决方案中另新建一个项目 .NET Core 的项目，我这里新建的是控制台项目。

在项目中右键点击依赖项，选择添加连接的服务，

在出现的新选项卡中的服务引用(OpenAPI, gRPC) 中点击添加按钮。

然后选择 OpenAPI 点击下一步，

重新启动步骤一中的 WebAPI 项目，

选择URL并填入先前的 Swagger 描述文件URL

http://localhost:5000/swagger/v1/swagger.json，点击完成等待完成即可。

（如果将swagger.json下载后，在这里使用文件也是可行的）

添加后项目中多了一个 ~/OpenAPIs/swagger.json 文件。
然后即可在代码中直接调用接口：

    static async Task Main(string[] args)
    {
        var http = new HttpClient();
        var client = new swaggerClient("http://localhost:5000/", http);
        var result = await client.WeatherForecastAsync();
        foreach (var item in result)
        {
            Console.WriteLine($"{item.Date}, {item.TemperatureF}, {item.Summary}");
        }
    
        Console.WriteLine("Hello World!");
    }

对于已配置的服务引用由于已经更改需要进行更新，则直接在更多列表中的刷新选项即可。