Swagger ist eine Framework-Implementierung zum Beschreiben, Produzieren, Konsumieren und Visualisieren von RESTful-Webdiensten basierend auf der OpenAPI-Spezifikation
Ich habe eine C # ASP.NET-WebAPI-Anwendung mit API-Dokumentation, die automatisch mit Swashbuckle generiert wird . Ich möchte in der Lage sein, bestimmte Methoden in der Dokumentation wegzulassen, aber ich kann anscheinend nicht herausfinden, wie ich Swagger anweisen kann, sie nicht in die Swagger-UI-Ausgabe aufzunehmen. Ich habe das Gefühl, dass dies …
Ich versuche zu vermitteln, dass für das Authentifizierungs- / Sicherheitsschema ein Header wie folgt festgelegt werden muss: Authorization: Bearer <token> Dies ist, was ich basierend auf der Prahler-Dokumentation habe : securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: - APIKey: []
Kürzlich habe ich erholsame APIs mit SpringMvc und swagger-ui (v2) geschrieben. Ich habe die Importfunktion in Postman bemerkt: Meine Frage ist also, wie man die Datei erstellt, die Postman benötigt. Ich kenne Swagger nicht.
Mein Projekt hat Spring Security. Hauptproblem: Zugriff auf die Swagger-URL unter http: // localhost: 8080 / api / v2 / api-docs nicht möglich . Es heißt Fehlender oder ungültiger Autorisierungsheader. Screenshot des Browserfensters Meine pom.xml enthält die folgenden Einträge <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> SwaggerConfig: …
Für einige in PHP geschriebene REST-APIs wurde ich gebeten, eine Swagger- Dokumentation zu erstellen. Da mir keine einfache Möglichkeit bekannt war, diesen vorhandenen APIs Anmerkungen hinzuzufügen und eine solche Dokumentation zu erstellen, habe ich diesen Editor verwendet , um einige zu generieren. Ich habe die mit diesem Editor erstellten JSON- …
Ich habe eine ReSTFul-API in einfachem Spring geschrieben (kein Spring Boot, kein schickes Zeug!). Ich muss Swagger in dieses implementieren. Bisher hat mich JEDE Seite im Internet nur durch verwirrende Konfigurationen und aufgeblähten Code verrückt gemacht, den ich überhaupt nicht tragbar fand. Hat jemand ein Beispielprojekt (oder eine Reihe detaillierter …
Angenommen, ich habe einen Parameter wie limit. Dieser wird überall verwendet und es ist ein Schmerz, ihn überall ändern zu müssen, wenn ich ihn aktualisieren muss: parameters: - name: limit in: query description: Limits the number of returned results required: false type: number format: int32 Kann ich $ ref verwenden, …
In meiner "vereinfachten" API werden alle Antworten von einer Basisklasse "Antwort" abgeleitet ( geerbt ). Die Antwortklasse besteht aus einem mit Metadaten gefüllten Header und dem Textkörper, der die vom Benutzer angeforderten Kerndaten enthält. Die Antwort (in JSON) ist so angelegt, dass sich alle Metadaten auf der ersten "Ebene" befinden …
Ich habe einige Endpunkte in der API - /user/login, /products. In der Swagger-Benutzeroberfläche poste ich emailund passwordan /user/loginund als Antwort erhalte ich eine tokenZeichenfolge. Dann kann ich das Token aus der Antwort kopieren und möchte es als AuthorizationHeader-Wert in Anforderungen an alle URLs verwenden, sofern vorhanden, und /productsals Beispiel. Sollte …
Ich habe die Swagger-API-Deklaration für Dienste, die Swagger v 1.2 verwenden Mein ursprüngliches Gefühl bei Swagger war, dass es dem JSON-Schema (Entwurf 3 und kürzlich Entwurf 4) sehr nahe kommt und es relativ einfach sein soll, ein JSON-Schema für Anforderungs- und Antwortobjekte zu generieren. Während ein Teil von Swagger JSON-Schemastrukturen …
Geschlossen . Diese Frage muss fokussierter sein . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so, dass sie sich nur auf ein Problem konzentriert, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 2 Jahren . Verbessere diese Frage Ich entwickle eine REST-API. Während …
Gibt es eine Methode zum Erstellen einer statischen Dokumentation für Swagger 2.0? Vielleicht wie die 'Vorschau' auf editor.swagger.io. Ich benötige statische HTML-Dateien, damit ich sie in einige statische Dokumente aufnehmen kann. Bisher habe ich keinen Weg gefunden, dies zu tun. Ich sehe, dass es swagger-codegens static-docs gibt, aber dies funktioniert …
In den letzten zwei Jahren habe ich mit Springfox an Spring Boot-Anwendungen gearbeitet. Springfox generiert eine Dokumentation und eine Test-Benutzeroberfläche für Ihre REST-API. Das war großartig. Aber tatsächlich ist das Springfox-Projekt tot und unterstützt nicht den neuesten Frühling. Ich habe drei Fragen Gibt es eine andere Möglichkeit, die Swagger-Benutzeroberfläche direkt …
Ich entwickle einige Web-APIs mit .Net Core 3.0 und möchte sie in SwashBuckle.Swagger integrieren. Es funktioniert einwandfrei, aber wenn ich die JWT-Authentifizierung hinzufüge, funktioniert es nicht wie erwartet. Dazu habe ich den folgenden Code hinzugefügt: services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "My Web API", Version = "v1" …
Ich integriere die Swagger-Benutzeroberfläche in mein Projekt. Ich muss das Token übergeben, um eine Anfrage zu stellen. const mytoken = "heareismytoken"; const ui = SwaggerUIBundle({ url: "/swagger/v2/swagger.json", dom_id: '#swagger-ui', deepLinking: true, requestInterceptor: function (req) { var key = mytoken; if (key && key.trim() !== "") { req.headers.Authorization = 'Bearer ' …
We use cookies and other tracking technologies to improve your browsing experience on our website,
to show you personalized content and targeted ads, to analyze our website traffic,
and to understand where our visitors are coming from.
By continuing, you consent to our use of cookies and other tracking technologies and
affirm you're at least 16 years old or have consent from a parent or guardian.