Tag: swashbuckle

Swashbuckle ist eine open-source-framework, das fügt Fors und Fors-ui ASP.NET Web API-Projekte.

Swagger UI: pass custom Authorization-header

Anzahl der Antworten 4 Antworten
Ich bin mit Swashbuckle und Swagger auf eine ASP.NET Web-API. Ich versuche einen Weg zu finden, übergeben Sie einen Authorization-header mit ein Bearer-token durch Swagger-UI. Ich habe gewesen suchend um, aber alle Antworten scheinen Punkt, an diese

Hinzufügen von Query-String-Parameter zu meinem Swagger-Spezifikationen

Anzahl der Antworten 3 Antworten
Ich bin mit Swashbuckle (Fors für C#) mit meinem Web-API. Ich habe mehrere BEKOMMEN, End-Punkte, die Rückgabe von Listen und ich dem Benutzer zu ermöglichen, fügen Sie ein perpage Seite und params in der QueryString Beispiel: http://myapi.com/endpoint/?page=5&perpage=10

Wie hinzufügen von API-Beschreibung in Swashbuckle?

Anzahl der Antworten 1 Antworten
Ich bin neu in Swashbuckl oder Schwadronieren, aber ich habe eine Web-API, die benötigt, um erstellen Sie eine Dokumentation mit Swagger von meinem client. Habe ich bereits erstellt, aber Sie benötigen den API-version-details werden angezeigt, in die

Fors - Web-API - Optionaler query-Parameter

Anzahl der Antworten 1 Antworten
[HttpGet] [Route("students")] [SwaggerOperation(Tags = new { "Student" })] [SwaggerResponse(HttpStatusCode.OK, Type = typeof(ResponseModel<IList<Student>>))] [SwaggerResponseExample(HttpStatusCode.OK, typeof(StudentResponseExample))] [SwaggerResponse(HttpStatusCode.InternalServerError)] public IHttpActionResult SearchStudent() { IDictionary<string, string> searchParams = null; searchParams = ControllerContext.GetQueryStrings(); . . . } Den oben genannten API hat drei

k__BackingField entfernen in C# (gesehen über Swashbuckle / Swagger)

Anzahl der Antworten 1 Antworten
Ich bin mit Swashbuckle 5 meine ASP.NET webapi-Projekt mit allen Standard-Einstellungen. Es serialisiert meine Methode ist-Ausgabe, um mir zu zeigen das schema der Antwort. Ich bin immer Dokumentation, die wie folgt aussieht: Response Class (Status 200) Model

Sollten Sie Kombinieren Swagger mit HATEOAS/HAL/JSON-LD?

Anzahl der Antworten 3 Antworten
Ich bin mit Swagger für meine ASP.NET Kern-API mit Swashbuckle, die beschreibt, meine API in ein separates Dokument und bietet eine schöne Benutzeroberfläche, die für alle diese Informationen. Gibt es irgendwelche Vorteile bei der Verwendung von so

Swashbuckle-Arroganz - Wie kommentieren von content-Typen?

Anzahl der Antworten 4 Antworten
Wie kann ich mein kommentieren ASP.NET WebAPI Aktionen, so dass die swagger Metadaten umfasst die content-Typen, die meine Ressourcen unterstützen? Speziell, ich will die Dokumentation zeigen, dass eine meiner Ressourcen können wieder die 'ursprünglichen' application/json und application/xml

swagger Fehler: Widersprüchliche schemaIds: Doppelte schemaIds erkannt, für die Typen A und B

Anzahl der Antworten 5 Antworten
Verwendung von Web-API und mit swashbuckle zu generieren swagger Dokumentation, Ich definiert zwei verschiedene Klassen mit dem gleichen Namen in zwei verschiedenen namespaces. wenn ich öffnen Sie stolzieren Seite in meinem browser sagt es Widersprüchliche schemaIds: Doppelte

Zum umleiten von Stamm-url auf /Fors/ui/index?

Anzahl der Antworten 7 Antworten
Ich habe eine WebApi-Projekt mit Swashbuckle auf installiert es. Im Standard-setup, muss ich im browser öffnen http://localhost:56131/swagger/ui/index zu meiner Operationen Beschreibung und test Seite. Ich will es zugänglich von der Wurzel der site: http://localhost:56131/. Wie kann ich

Was ist Swagger und bezieht es sich auf OData?

Anzahl der Antworten 1 Antworten
Ich bin vertraut mit den Microsoft-stack. Ich bin mit OData für einige meiner restful services. Vor kurzem stieß ich auf Swagger für die API-Dokumentation, und ich versuche zu verstehen, wie es bezieht sich auf OData. Beide von

Swashbuckle/Swagger + ASP.Net Kern: "Fehler beim laden der API-definition"

Anzahl der Antworten 8 Antworten
Entwickle ich eine ASP.NET Core-2-Anwendung und enthalten Stolzieren. Alles funktionierte gut, bis ich eingeführt, eine Methode, die ohne explizit definieren Sie die HTTP-Aktion: public class ErrorController : Controller { [Route("/error")] public IActionResult Index() { return StatusCode(500, new

ASP.NET Core - Swashbuckle schaffen nicht Gewinn.json-Datei

Anzahl der Antworten 8 Antworten
Ich habe Probleme damit, die Swashbuckle.AspNetCore (1.0.0) Paket erzeugen keine Ausgabe. Ich lese die Angeberei.json-Datei geschrieben werden sollten '~/swagger/docs/v1'. Aber ich bekomme keine Ausgabe. Begann ich mit einer neuen Marke ASP.NET Kern-API Projekt. Ich sollte erwähnen, das

Nicht unterstützt von Swagger 2.0: Mehrere Operationen mit Pfad

Anzahl der Antworten 6 Antworten
Habe ich integriert swagger in WebApi 2 Anwendung. Es funktioniert, wenn die Anwendung verfügt über Einzel-controller. Wenn ich zusätzlichen zweiten controller in der Anwendung. Ich bekam folgende Fehlermeldung : Ist ein Fehler aufgetreten.","ExceptionMessage":"Nicht unterstützt Swagger 2.0: Mehrere

Swashbuckle-parameter-Beschreibungen

Anzahl der Antworten 3 Antworten
Ich bin mit SwaggerResponse Attributen zu schmücken api controller-Aktionen, das alles funktioniert Prima, aber wenn ich mir die generierte Dokumentation das Feld Beschreibung für Parameter leer ist. Ist es eine Attribut-basierte Ansatz zur Beschreibung von action-Parametern (anstatt

Wie kann ich url-Pfad in Swashbuckle/Swaggerwork wenn api serviert, von innen ein anderes Projekt?

Anzahl der Antworten 1 Antworten
alle. Ich bin versucht zu dokumentieren, eine WebApi 2 mit Swashbuckle-Paket. Funktioniert alles Super, wenn die API ausgeführt wird, indem sich also localhost/api/swagger bringt mich zu ui und localhost/api/swagger/docs/v1 zu json. Jedoch die producation-app initialisiert das gleiche

Wie zum senden von Authorization-header mit einer Anfrage in Swagger-UI?

Anzahl der Antworten 3 Antworten
Habe ich eine ASP.NET Web Api 2 Anwendung. Ich fügte hinzu, Swashbuckle (Fors für .NET). Es zeigt meine Endpunkte kein problem, aber um eine Anfrage zu senden, die ich brauche zum anschließen eines Authorization headers auf Anfrage.

500 Fehler beim einrichten Swagger in asp .net CORE / MVC 6-app

Anzahl der Antworten 6 Antworten
Ich versuche zum einrichten einer einfachen Fors API-doc in eine neue asp .net CORE /MVC 6-Projekt und erhalten Sie einen 500 Fehler aus dem swagger-UI: 500 : http://localhost:4405/swagger/v1/swagger.json Meine startup-Klasse den folgenden code in es: using Swashbuckle.SwaggerGen;

Bearer-Token in Swashbuckle aktivieren (Swagger-Dokument)

Anzahl der Antworten 1 Antworten
Erstellte ich eine asp.net webapi-Anwendung, die mit Einzelnen Account-Sicherheitso dass die Inhaber-token ist standardmäßig aktiviert. Es arbeitet fein, so dass ich in der Lage bin Sie zu testen, im Postbote ohne problem. Hier kommt die Frage, wenn

Swashbuckle 5 kann meine ApiControllers nicht finden

Anzahl der Antworten 7 Antworten
Ich bin an einem Punkt, wo ich wirklich brauchen, API-Dokumentation für meinen WebAPI 2-Projekt, und ich benutzte die Swashbuckle 5 NuGet-Paket. Out of the box, ich kann hit {myrooturl}/swagger und ein UI erscheint, aber es gibt keine

Swagger UI Web Api Dokumentation Present enums als Zeichenfolgen?

Anzahl der Antworten 3 Antworten
Gibt es einen Weg, um alle enums, wie Ihre string-Wert in Fors statt des int-Wert? Möchte ich Einreichen können, POST-Aktionen und setzen Enumerationen, die nach Ihrer string-Wert ohne Blick auf die enum-jedes mal. Versuchte ich DescribeAllEnumsAsStrings aber

swagger-ui gibt 500 nach der Bereitstellung zurück

Anzahl der Antworten 5 Antworten
Out-of-the-box-Konfiguration funktioniert perfekt auf meinem Rechner, keine Probleme überhaupt. Aber wenn ich bereitzustellen unsere test-Umgebung - bekomme ich folgende Meldung 500 : { "Message": "Ein Fehler ist aufgetreten." } /api/swagger/docs/v1 Die Bereitstellung ist default web site/api Ich

Kann das Dateiproblem in Swagger UI nicht lesen

Anzahl der Antworten 4 Antworten
Habe ich aufgenommen swagger-UI in meiner Anwendung. Wenn ich versuchen und sehen, Fors UI, bekomme ich die Dokumentation der API sehr schön, aber nach einiger Zeit zeigt er einige Fehler auf das Symbol Schaltfläche. Die Fehlermeldung ist