Swagger Swashback ASP.NET核心消费应用程序/x-www-form-urlencoded

Swagger Swashback ASP.NET核心消费应用程序/x-www-form-urlencoded,swagger,swashbuckle,Swagger,Swashbuckle,我有一个使用application/x-www-form-urlencoded的操作: [HttpPost("~/connect/token"), Consumes("application/x-www-form-urlencoded")] public async Task<IActionResult> Exchange([FromBody]OpenIdConnectRequest request) { .. } [HttpPost(“~/connect/token”),使

我有一个使用application/x-www-form-urlencoded的操作:

[HttpPost("~/connect/token"), Consumes("application/x-www-form-urlencoded")]
public async Task<IActionResult> Exchange([FromBody]OpenIdConnectRequest request)
{
   ..
}
[HttpPost(“~/connect/token”),使用(“application/x-www-form-urlencoded”)]
公共异步任务交换([FromBody]OpenIdConnectRequest请求)
{
..
}
但是Swashback为
消费属性
生成空数组。如果我将其更改为
application/json
,则正确生成consumes数组


这是一个与
应用程序/x-www-form-urlencoded
相关的错误,还是我需要额外配置Swashback以支持此应用程序类型?

Swashback的开箱即用功能无法满足“consumes”的需求,需要一个自定义扩展,如本部分所述

有三个步骤:

  • 创建参数属性
  • 创建扩展名
  • 向SwashBuck添加说明以处理新扩展
  • 向控制器方法中的参数添加属性
  • 我将在中添加更多说明,但代码如下:

    1.FromFormDataBodyAttribute.cs
    这在Core3.1中适用,但您需要将该方法修改为swagger和OpenAPI3的实际版本
    using System;
    using System.Collections.Generic;
    using System.Net.Http.Formatting;
    using System.Web.Http;
    using System.Web.Http.Controllers;
    using System.Web.Http.Validation;
    
    /// <summary>
    /// FromFormDataBody Attribute
    /// This attribute is used on action parameters to indicate
    /// they come only from the content body of the incoming HttpRequestMessage.
    /// </summary>
    [AttributeUsage(AttributeTargets.Parameter, Inherited = true, AllowMultiple = false)]
    public sealed class FromFormDataBodyAttribute : ParameterBindingAttribute
    {
        /// <summary>
        /// GetBinding
        /// </summary>
        /// <param name="parameter">HttpParameterDescriptor</param>
        /// <returns>HttpParameterBinding</returns>
        public override HttpParameterBinding GetBinding(HttpParameterDescriptor parameter)
        {
            if (parameter == null)
                throw new ArgumentNullException("parameter");
    
            IEnumerable<MediaTypeFormatter> formatters = parameter.Configuration.Formatters;
            IBodyModelValidator validator = parameter.Configuration.Services.GetBodyModelValidator();
    
            return parameter.BindWithFormatter(formatters, validator);
        }
    }
    
    using Swashbuckle.Swagger;
    using System.Linq;
    using System.Web.Http.Description;
    
    /// <summary>
    /// Add UrlEncoded form data support for Controller Actions that have FromFormDataBody attribute in a parameter
    /// usage: c.OperationFilter<AddUrlFormDataParams>();
    /// </summary>
    public class AddUrlFormDataParams : IOperationFilter
    {
        public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
        {
            var fromBodyAttributes = apiDescription.ActionDescriptor.GetParameters()
                .Where(param => param.GetCustomAttributes<FromFormDataBodyAttribute>().Any())
            .ToArray();
    
            if (fromBodyAttributes.Any())
                operation.consumes.Add("application/x-www-form-urlencoded");
    
            foreach (var headerParam in fromBodyAttributes)
            {
                if (operation.parameters != null)
                {
                    // Select the capitalized parameter names
                    var parameter = operation.parameters.Where(p => p.name == headerParam.ParameterName).FirstOrDefault();
                    if (parameter != null)
                    {
                        parameter.@in = "formData";//NB. ONLY for this 'complex' object example, as it will be passed as body JSON.
    //TODO add logic to change to "query" for string/int etc. as they are passed via query string.
                    }
                }
            }
        }
    }
    
     //Add UrlEncoded form data support for Controller Actions that have FromBody attribute in a parameter
    c.OperationFilter<AddUrlFormDataParams>();
    
    [FromFormDataBody]OpenIdConnectRequest request