Web-Api zum hinzufügen einer Header-parameter für alle API in Fors

Suchte ich nach Möglichkeiten zum hinzufügen von ein Anfrage-header-parameter werden würden automatisch Hinzugefügt, um jede Methode, die in meinem web-api finden konnte ich aber nicht klar.

Beim suchen habe ich festgestellt, dass die Methode OperationFilter() hat, etwas dagegen zu tun.

Würde gerne wissen, ob dies getan werden kann, über die Swagger-UI?

InformationsquelleAutor | 2017-01-05

  1. 16

    Kann man ja über die Erben von IOperationFilter

    Finden Sie die Antwort auf GitHub hier: AddRequiredHeaderParameter 

    using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;

public class AddRequiredHeaderParameter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        if (operation.Parameters == null)
            operation.Parameters = new List<IParameter>();

        operation.Parameters.Add(new NonBodyParameter
            {
                Name = "X-User-Token",
                In = "header",
                Type = "string",
                Required = false
            });
    }
}

    Dann gehen Sie zu Ihrem SwaggerConfig.cs - Datei und fügen Sie Folgendes in die AddSwaggerGen Abschnitt: 

    c.OperationFilter<AddRequiredHeaderParameter>();

    Neu aufbauen und genießen.

    Danke!!! Es funktionierte
    ich versuche Sie auf hinzufügen.c.OperationFilter(() => neue AddRequiredHeaderParameter()); aber ich bin immer der Typ konvertieren Fehler. Fehler ist Fehler 21 kann Nicht implizit konvertiert Typ 'SwaggerDemo.AddRequiredHeaderParameter' zu 'Swashbuckle.Stolzieren.IOperationFilter'. Eine explizite Konvertierung vorhanden ist (fehlt ein cast?) D:\Prashant\Demo\WebApiDemoWithSwaggerBasicAuth(1)\WebApiDemoWithSwaggerBasicAuth\SwaggerDemo\App_Start\SwaggerConfig.cs 19 49 SwaggerDemo
    Es scheint, dass das problem in der ` AddRequiredHeaderParameter ` Klasse versuchen zu Erben ` IOperationFilter stellen Sie sicher, dass Sie installiert stolzieren und auf die es zu Ihrem Projekt.
    Ok danke für die Hilfe. jetzt habe ich dieses Problem gelöst.
    wie Sie header hinzufügen, die für jede API-Methode nicht als common-header ?

    InformationsquelleAutor Ramy Mohamed

  2. 3

    Ich hatte dies etwas anders, nicht sicher, warum. Hier war, was ich Tat, fügen Sie ein header-Wert:

    Dieser wurde Hinzugefügt, um mein swagger config:

        c.OperationFilter<AddRequiredHeaderParameter>();

    - Und dies war das Klasse:

        public class AddRequiredHeaderParameter : IOperationFilter
    {
        public void Apply(Operation operation, OperationFilterContext context)
        {
            operation.Parameters.Add(new NonBodyParameter
            {
                Name = "X-MYHEADER",
                In = "header",
                Type = "string",
                Required = false
            });
        }
    }

    InformationsquelleAutor Mr Giggles

  3. 0

    Außerdem können Sie ein Basis-model-Klasse, und verwenden Sie das Attribut [FromHeader] für die Eigenschaften, die gesendet werden sollen, in custom-Header. So etwas wie dieses: 

    public class AuthenticatedRequest
{
    [FromHeader(Name = "User-Identity")]
    public string UserIdentity { get; set; }
}

    Mindestens es funktioniert gut für ASP.NET Core 2.1 und Swashbuckle.AspNetCore 2.5.0.

    InformationsquelleAutor Victor Sharovatov

  4. 0

    Andere Möglichkeit zum hinzufügen von benutzerdefinierten Header ist durch hinzufügen von Parametern in die Steuerung.

    Im folgenden Beispiel wird add x-test parameter auf der Benutzeroberfläche:

    [HttpPost]
public IActionResult Test([FromHeader(Name="x-test")][Required] string requiredHeader)
{
    return Ok();
}

    Web-Api zum hinzufügen einer Header-parameter für alle API in Fors

    InformationsquelleAutor Pavel Agarkov

Schreibe einen Kommentar