.Net Core2.1 WebAPI新增Swagger插件详解

Swagger是一种API文档工具，它可以自动生成API文档，并提供一个交互式的UI界面，方便开发人员测试API。在.Net Core2.1中，我们可以使用Swagger插件来自动生成API文档。本攻略将详细介绍如何使用Swagger插件。

安装Swagger插件

我们可以使用以下命令来安装Swagger插件：

dotnet add package Swashbuckle.AspNetCore

配置Swagger插件

我们可以在Startup.cs文件中配置Swagger插件。以下是一个简单的示例：

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(options =>
    {
        options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
        options.OperationFilter<AddAuthHeaderOperationFilter>();
    });
}

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

在上面的代码中，我们使用AddSwaggerGen方法来添加Swagger支持。我们使用SwaggerDoc方法来设置API文档的标题和版本号。我们使用OperationFilter方法来添加一个操作过滤器。我们使用UseSwagger方法来启用Swagger。我们使用UseSwaggerUI方法来启用Swagger UI。

示例说明

示例1：返回JSON数据

我们可以使用以下代码来返回JSON数据：

[HttpGet]
public ActionResult<IEnumerable<string>> Get()
{
    return new string[] { "value1", "value2" };
}

在上面的代码中，我们使用HttpGet特性来定义一个GET请求的路由。我们返回一个包含两个字符串的JSON数组。

示例2：接收POST请求

我们可以使用以下代码接收POST请求：

[HttpPost]
public void Post([FromBody] string value)
{
    // 处理请求数据
}

在上面的代码中，我们使用HttpPost特性来定义一个POST请求的路由。我们使用FromBody特性来指定请求体中的数据，并将其转换为字符串。我们可以在处理请求数据后返回响应。

结论

本攻略介绍了如何使用Swagger插件来自动生成API文档。我们提供了详细的步骤和两个示例说明，以帮助快速上手Swagger插件。使用Swagger插件可以更轻松地创建和维护API文档，提高开发效率。