.Net core3.0 集成swagger5.0上傳文件

    .Net core 3.0已經更新了，相信有挺多博主大佬們都更新了如何在.Net core3.0使用swagger，這里就不詳細說了。

我們知道，如果.net core 2.x使用swagger上傳文件是需要寫個操作過濾器的類。

public class SwaggerFileUploadFilter : IOperationFilter
    {
        public void Apply(Operation operation, OperationFilterContext context)
        {
            if (!context.ApiDescription.HttpMethod.Equals("POST", StringComparison.OrdinalIgnoreCase) &&
                !context.ApiDescription.HttpMethod.Equals("PUT", StringComparison.OrdinalIgnoreCase))
            {
                return;
            }

            var fileParameters = context.ApiDescription.ActionDescriptor.Parameters.Where(n => n.ParameterType == typeof(IFormFile)).ToList();

            if (fileParameters.Count < 0)
            {
                return;
            }

            operation.Consumes.Add("multipart/form-data");

            foreach (var fileParameter in fileParameters)
            {
                var parameter = operation.Parameters.Single(n => n.Name == fileParameter.Name);
                operation.Parameters.Remove(parameter);
                operation.Parameters.Add(new NonBodyParameter
                {
                    Name = parameter.Name,
                    In = "formData",
                    Description = parameter.Description,
                    Required = parameter.Required,
                    Type = "file"
                });
            }
        }
    }

需要在startup類中配置：

 

 

 這樣上傳文件的api就有選擇文件的按鈕了：

 

 

 然后升級到.net core 3.0 ，swagger目前4.x版本不支持，只能下5.x的預覽版，然后一堆報錯。首先配置中的Info 需要改成OpenApiInfo：

  services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info { Title = "Web API", Version = "v1" });
                var xmlPath = Path.Combine(AppContext.BaseDirectory, "swagger.xml");
                c.IncludeXmlComments(xmlPath);
                c.OperationFilter<SwaggerFileUploadFilter>();
            });

改成：

  services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "Web API", Version = "v1", Description = "Web API" });
                var xmlPath = Path.Combine(AppContext.BaseDirectory, "swagger.xml");
                c.IncludeXmlComments(xmlPath);
            });

而且swagger 5.0版本不需要手動寫過濾器類，也就是

SwaggerFileUploadFilter

上文提到的這個類。

直接正常寫api就可以了，不過IFormFile參數一定不要加[FromBody]這個特性。就像這樣：

        /// <summary>
        /// 上傳文件
        /// </summary>
        /// <param name="formFile">文件</param>
        /// <returns></returns>
        [HttpPost]
        public IActionResult test(IFormFile formFile)
        {
            return Ok("靚仔");
        }

然后打開swagger就可以看到：

 

 

結束！