Fügen Sie eine eigenständige Definition ein, um Operationen, Request-Bodies, Antworten und Schemas zu erkunden, ohne sie irgendwohin zu senden. Die Ansicht prüft die Version und löst jeden Verweis im eingefügten Dokument auf, bevor sie rendert.
Diese Ansicht dient der visuellen Vertragsprüfung: Sie sendet keine Anfragen, speichert keine Autorisierungen, lädt keine entfernten Definitionen und löst keine Verweise außerhalb des eingefügten Dokuments auf. Nutzen Sie den Explorer, wenn Sie aus kopierten API-Details eine Anfrage erzeugen möchten.
Fügen Sie eine OpenAPI-3.x- oder Swagger-2.0-Definition ein und lesen Sie sie als Swagger-UI-Dokumentation, ohne sie irgendwohin zu senden. Parsen, Prüfen und Rendern laufen in diesem Tab, Try it out ist abgeschaltet, und die gemessene Zahl der Anfragen beim Rendern bleibt bei null.
Die Ansicht prüft die Definition vorher. Die Wurzel muss eine unterstützte Version tragen, jeder $ref muss in dasselbe Dokument zeigen, und alle diese Verweise müssen sich auflösen; alles andere wird in der Statuszeile gemeldet, statt eine halb gerenderte Seite zu hinterlassen.
OpenAPI-3.x- und Swagger-2.0-Wurzeln werden akzeptiert; das Versionsfeld ist Pflicht, und openapi: 4.x wird mit einer Meldung abgelehnt statt mit einer Fehlerseite von Swagger UI. Gelesen werden JSON und die YAML-Teilmenge, die OpenAPI-Dateien nutzen: Mappings, Sequenzen, Inline-Sammlungen [] und {}, Schlüssel in Anführungszeichen, Kommentare, Block-Skalare | und > mit Chomping, Anker und Aliase (&name / *name) sowie die Tags !!str, !!int, !!float, !!bool und !!null. Ein zweites Dokument nach --- wird als Fehler gemeldet, statt mit dem ersten verschmolzen zu werden.
Unterstützt werden nur Verweise im eingefügten Dokument. ./schemas/a.json, a.yaml, relative Pfade und http(s)-URLs werden vor dem Rendern abgelehnt, und die Meldung nennt die Eigenschaft, die sie trägt; eine Definition, die auf eine relative Datei zeigt, wird also gemeldet, statt sie still von dieser Seite anzufordern. Lokale Verweise wie #/components/schemas/Note werden gegen das eingefügte Dokument aufgelöst, und ein Verweis auf einen fehlenden Knoten wird sofort gemeldet, statt erst beim Aufklappen der Operation zu scheitern.
Die Vorschau listet Operationen mit Parametern, Request-Bodies, Antworten und Schemas in der schlichten Swagger-UI-Basisansicht, ohne Try-it-out-Schaltfläche und ohne Autorisierungsformular. In dieser Fassung gemessen: Das mitgelieferte Beispiel rendert zwei Operationen, eine Definition mit 200 Operationen braucht rund eine Viertelsekunde, und zweimaliges Rendern desselben Dokuments dupliziert die Vorschau nicht.