我有一个使用application / x-www-form-urlencoded的Action:
[HttpPost("~/connect/token"),Consumes("application/x-www-form-urlencoded")] public async Task<IActionResult> Exchange([FromBody]OpenIdConnectRequest request) { .. }
但Swashbuckle为Consumes属性生成空数组.如果我将其更改为application / json,则会正确生成消耗数组.
它是与application / x-www-form-urlencoded相关的错误还是我需要另外配置Swashbuckle来支持这种应用程序类型?
解决方法
对于Swashbuckle而言,“消耗”不适合开箱即用,需要自定义扩展,就像
@domaindrivendev’s GitHub project的这一部分一样
有三个步骤:
>创建参数属性
>创建扩展
>向Swashbuckle添加指令以处理新扩展
>在Controller方法中为参数添加属性
我将在my fork of the repo中添加更多说明,但这里是代码:
1. FromFormDataBodyAttribute.cs
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); } }
2 AddUrlFormDataParams.cs
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. } } } } }
3更新Swagger.config
//Add UrlEncoded form data support for Controller Actions that have FromBody attribute in a parameter c.OperationFilter<AddUrlFormDataParams>();
4.在Controller方法中向参数添加属性
[FromFormDataBody]OpenIdConnectRequest request
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。