在Swagger上为. net web api调用添加自定义头字段的最佳实践是什么？

Question

var webScope = apiDescription.ActionDescriptor.GetFilterPipeline()
   .Select(filterInfo => filterInfo.Instance)
   .OfType<WebAuthorize>()
   .SelectMany(attr => attr.Roles.Split(','))
   .Distinct();

var mobileScope = apiDescription.ActionDescriptor.GetFilterPipeline()
    .Select(filterInfo => filterInfo.Instance)
    .OfType<MobileAuthorize>()
   .SelectMany(attr => attr.Roles.Split(','))
   .Distinct();

它之所以有效，是因为我在授权 API 调用时有两种不同的方法，如您所见，我有一个移动授权和一个 Web 授权，所以我的 api 调用看起来像这样：

[HttpGet]
[Route("something")]
[WebAuthorize(Code = PermissionCode, Type =PermissionType)]
public async Task<Dto> Getsomething()
{
    return await unitOfWork.GetService<ISomething>().GetSomething();
}

使用API描述。RelativePath，我将检查相对路径是否等于我要添加的自定义标头的api调用，例如：

[HttpPost]
[Route("rename")]
[InHouseAuthorize(Code = PermissionCode, Type =PermissionType)]
public async Task<HttpResponseMessage> RenameDevice()
{
    HttpRequestMessage request = Request ?? new HttpRequestMessage();
    String deviceName = request.Headers.GetValues("deviceName").FirstOrDefault();
    String deviceGuid = request.Headers.GetValues("deviceGuid").FirstOrDefault();
    await unitOfWork.GetService<IDeviceService>().RenameDevice(deviceGuid, deviceName);
    await unitOfWork.Commit();
    return new HttpResponseMessage(HttpStatusCode.OK);
}

    if (apiDescription.RelativePath.Contains("device/rename"))
    {
        operation.parameters.Add(new Parameter
        {
            name = "deviceGuid",
            @in = "header",
            description = "Add the Device Guid",
            type = "string",
            required = false
        });
        operation.parameters.Add(new Parameter
        {
            name = "DeviceName",
            @in = "header",
            description = "Add the Device Name",
            type = "string",
            required = false
        });
    }

我正在寻找处理此问题的最佳方法。

Answer 1

可以将属性 [FromHeader] 用于 Web 方法参数（或 Model 类中的属性），这些参数应在自定义标头中发送。像这样：

[HttpGet]
public ActionResult Products([FromHeader(Name = "User-Identity")]string userIdentity)

对我来说，这似乎是最简单的解决方案。至少它适用于 ASP.NET Core 2.1和Swashbuckle.AspNetCore 2.5.0。