如何使用Swagger上传文件

Swagger是一种流行的API文档工具，它可以帮助开发人员快速创建和测试API。在Swagger中，可以使用Swagger UI来测试API，其中包括上传文件的功能。下面是如何使用Swagger上传文件的完整攻略：

步骤一：安装Swagger

首先，需要安装Swagger。可以使用以下命令在.NET Core应用程序中安装Swagger：

dotnet add package Swashbuckle.AspNetCore

步骤二：配置Swagger

接下来，需要配置Swagger。可以使用以下代码在“Startup.cs”文件中配置Swagger：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.OpenApi.Models;

namespace MyApi
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

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

            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
            });
        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
            });
        }
    }
}

在上面的代码中，我们使用 AddSwaggerGen 方法添加 Swagger 文档生成器，并使用 UseSwagger 和 UseSwaggerUI 方法启用 Swagger UI。

示例一：上传单个文件

以下是一个示例，演示如何使用Swagger上传单个文件：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using System.IO;

namespace MyApi.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class UploadController : ControllerBase
    {
        private readonly ILogger<UploadController> _logger;

        public UploadController(ILogger<UploadController> logger)
        {
            _logger = logger;
        }

        [HttpPost]
        public IActionResult Upload(IFormFile file)
        {
            if (file == null || file.Length == 0)
            {
                return BadRequest("文件不能为空");
            }

            var fileName = Path.GetFileName(file.FileName);
            var filePath = Path.Combine(Directory.GetCurrentDirectory(), "uploads", fileName);

            using (var stream = new FileStream(filePath, FileMode.Create))
            {
                file.CopyTo(stream);
            }

            _logger.LogInformation($"已上传文件：{fileName}");

            return Ok($"已上传文件：{fileName}");
        }
    }
}

在上面的代码中，我们定义了一个 UploadController 类，它包含一个 Upload 方法，用于上传文件。在 Upload 方法中，我们首先检查文件是否为空，然后将文件保存到本地，并记录日志。

示例二：上传多个文件

以下是一个示例，演示如何使用Swagger上传多个文件：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;
using System.IO;

namespace MyApi.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class UploadController : ControllerBase
    {
        private readonly ILogger<UploadController> _logger;

        public UploadController(ILogger<UploadController> logger)
        {
            _logger = logger;
        }

        [HttpPost]
        public IActionResult Upload(List<IFormFile> files)
        {
            if (files == null || files.Count == 0)
            {
                return BadRequest("文件不能为空");
            }

            foreach (var file in files)
            {
                if (file.Length == 0)
                {
                    continue;
                }

                var fileName = Path.GetFileName(file.FileName);
                var filePath = Path.Combine(Directory.GetCurrentDirectory(), "uploads", fileName);

                using (var stream = new FileStream(filePath, FileMode.Create))
                {
                    file.CopyTo(stream);
                }

                _logger.LogInformation($"已上传文件：{fileName}");
            }

            return Ok("已上传文件");
        }
    }
}

在上面的代码中，我们修改了 Upload 方法，使其可以上传多个文件。在 Upload 方法中，我们首先检查文件是否为空，然后将每个文件保存到本地，并记录日志。

步骤三：测试上传文件

最后，需要使用 Swagger UI 测试上传文件。可以使用以下步骤测试上传文件：

1. 启动应用程序。
2. 在浏览器中，导航到“http://localhost:5000/swagger”。
3. 在 Swagger UI 中，找到 UploadController，并单击“POST /upload”。
4. 单击“Try it out”按钮。
5. 在“Request body”部分，单击“Choose File”按钮，并选择要上传的文件。
6. 单击“Execute”按钮。
7. 在“Response body”部分，查看上传文件的结果。

在上面的步骤中，我们使用 Swagger UI 测试了上传文件的功能。可以在“Request body”部分选择要上传的文件，并在“Response body”部分查看上传文件的结果。