ASP.NET Core WebApi使用Swagger生成api说明文档-慕源网

介绍

Swagger 是一个开源工具，用于通过 Swagger UI 直接与 API 交互。在本文中，我们将看到如何在 ASP.NET Core WebApi使用Swagger生成api说明文档。

让我们开始吧，

首先，创建一个示例 Asp.net Core Web 应用程序。

为应用程序指定一个有意义的名称，这里我将名称命名为 SwaggerDemoApplication。

创建项目后，让我们添加一个新控制器。我添加了 HomeController。创建控制器后，将以下 NuGet 包添加到应用程序中，

Swashbuckle.AspNetCore
Swashbuckle.AspNetCore.Swagger
Swashbuckle.AspNetCore.SwaggerUI

创建新文件夹 Model 并添加 Employee 类。

public class Employee {
    public int Id {
        get;
        set;
    }
    public string FirstName {
        get;
        set;
    }
    public string LastName {
        get;
        set;
    }
    public string EmailId {
        get;
        set;
    }
}

现在将下面的 Actionmethod 添加到 Homecontroller 中。

public List < Employee > GetEmployee() {
    return new List < Employee > () {
        new Employee() {
                Id = 1,
                    FirstName = "Yogesh",
                    LastName = "Vedpathak",
                    EmailId = "yogeshvedpathak333@gmail.com"
            },
            new Employee() {
                Id = 2,
                    FirstName = "Amit",
                    LastName = "Kanse",
                    EmailId = "AmitKanse@gmail.com"
            }
    };
}

配置 Swagger 中间件

现在是在 startup.cs 类中配置服务的时候了。打开 startup.cs 类并将以下代码行添加到配置服务方法中。

public void ConfigureServices(IServiceCollection services) {
    // Register the Swagger or more Swagger documents
    services.AddSwaggerGen(c => {
        c.SwaggerDoc("v1", new OpenApiInfo {
            Title = "SwaggerDemoApplication", Version = "v1"
        });
    });
    services.AddControllers();
}

在配置方法中添加以下代码行。基本上，我们将为 swagger UI 启用中间件。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env) {
        // Enable middleware Swagger for JSON endpoint.
        app.UseSwagger();
        app.UseSwaggerUI(c => {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", SwaggerDemoApplication V1 ");
                });
        }

现在是检查结果的时候了。运行应用程序并导航到 https://localhost:44338/swagger/Index.html。