So ändern Sie die Basis-url von Swagger in ASP.NET Kern

Standardmäßig beim aktivieren von swagger in ASP.NET Kern-Projekt, es ist verfügbar auf url:

http://localhost:<random_port>/swagger/ui

Ich würde gerne auf einen anderen Basis-url statt /swagger/ui. Wie/wo kann ich konfigurieren, dass?

Fand ich, dass für ältere Versionen können Sie die Konfiguration des RootUrl aber es gibt keine ähnliche Methode in ASP.NET Kern:

.EnableSwagger(c =>
{
    c.RootUrl(req => myCustomBasePath);
});
Lassen Sie mich wissen, wenn es für Sie gearbeitet.

InformationsquelleAutor Mariusz Jamro | 2016-08-24

  1. 25

    Den neuen Fors version bietet Ihnen eine Eigenschaft, die man als RoutePrefix.

       app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                c.RoutePrefix = "docs";
            });

    InformationsquelleAutor maxspan

  2. 1
    1. Öffnen Sie die launchSettings.json Datei.
    2. Unter der "profile" Knoten, abhängig von Ihrer Einstellung sollten Sie haben ein oder mehrere profile. In kann Fall hatte ich "IIS Express" und ein weiteres mit dem Namen mein Projekt den Namen (e.g WebApplication1 ), jetzt ändern die launchUrl Eintrag zu "launchUrl": "swagger" mein problem gelöst.
    3. Wenn das nicht funktioniert, und Sie haben anderen Profilen das gleiche tun und testen.

    InformationsquelleAutor Mxaza

  3. 0

    Den UseSwaggerUi() Erweiterung Methode zum aktivieren der middleware in der Configure-Methode der Start-Klasse übernimmt zwei Variablen. Ein baseRoute die auf swagger/ui standardmäßig, und swaggerUrl die auf swagger/v1/swagger.json standardmäßig. Geben Sie einfach eine andere baseRoute.

    //Swagger will be available under '/api' url
app.UseSwaggerUi("api");

    Wenn die Menschen möchten, erfahren Sie mehr über das konfigurieren von Swagger für ASP.NET Core, die ich geschrieben habe, einen blogpost zu beginnen: https://dannyvanderkraan.wordpress.com/2016/09/09/asp-net-core-1-0-web-api-automatic-documentation-with-swagger-and-swashbuckle/

    InformationsquelleAutor Danny van der Kraan

  4. 0

    Können Sie tun dies auch in der Config

    app.UseSwaggerUI(c =>
            {
                c.RoutePrefix = string.Empty;
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "MY API");
            });

    InformationsquelleAutor Jackboys

  5. 0

    Für ASP.NET Core 2 (und mit Swashbuckle.AspNetCore.Swagger -Version 4.0.1), ein paar Dinge, die getan werden kann für eine vollständige Konfiguration änderung des Standard-swagger-UI-base-URL.

    Wenn Sie möchten, fügen Sie "mycoolapi" an den Anfang des Standard-swagger-UI-URL wie folgt: http://<server>/mycoolapi/swagger, dann tun Sie das folgende:

    In Ihrem Startup.cs Konfigurieren-Methode:

        app.UseSwagger(c =>
    {
        c.RouteTemplate = "mycoolapi/swagger/{documentname}/swagger.json";
    });


    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/mycoolapi/swagger/v1/swagger.json", "My Cool API V1");
        c.RoutePrefix = "mycoolapi/swagger";
    });

    Dann, wenn Sie derzeit haben Ihre launchSettings, starten Sie den browser auf swagger-UI beim Start (für Entwicklungszwecke), aktualisieren Sie Ihre launchSettings.json-Datei profile-Abschnitt ist ähnlich:

      "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "mycoolapi/swagger",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "Crane.Web": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "mycoolapi/swagger",
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }

    InformationsquelleAutor EspressoBeans

Schreibe einen Kommentar