Validierung von JSON gegen Swagger-API-schema

Erstellte ich eine API spec von einigen von JSON-Dateien und ich bin versucht, um zu testen, ob die Dateien validieren, gegen die API spec.

Gibt es einige gute tools für die Validierung mit JSON-Schema, aber ich habe nicht die chance, ein tool zu finden, zu validieren, gegen die Spezifikationen erstellt, in der Fors (tool zum erstellen von API-schema). Die einzige Lösung, die ich gefunden, ist die Erzeugung eines client/server in der Fors-Editor ist es ziemlich umständlich.

Gibt es bereits ein bestehendes tool zu validieren JSON-gegen Swagger Schema?

Willst du überprüfen, dass deine Skillung ist eine gültige Open API (fka. Swagger) spec oder bestätigen, dass eine Implementierung dieser Spezifikation produzieren würde, JSON, die gültig ist in Bezug auf Ihre JSON-schemas?
Die Frage ist allein zu überprüfen, ob ein JSON-gültig für die Open API spec.
Haben Sie sah medium.com/@betz.mark/... ?
Fors validator Knoten ein Paket (npmjs.com/package/swagger-validation) sieht auch gut geeignet.
hast du das gelöst? Ich sehe keine befriedigende Antwort.

InformationsquelleAutor Peter Gerhat | 2016-09-01

  1. 18

    Arnaud in den Kommentaren ist richtig, dass es zwei getrennte Fragen hier.

    Willst du überprüfen, dass deine Skillung ist eine gültige Open API (fka. Swagger) spec

    Können Sie

    • Kopiere deine Skillung auf die online-Swagger-editor und es wirft Fehler. Ein schnelles abtauchen durch die Quelle nicht mir sagen, was es mit, um diese Fehler, aber es scheint nicht zu sein, die Kontaktaufnahme mit einem server zu tun...
    • Das offizielle Fors-parser für Java.
    • Verwenden Sie die inoffizielle Fors-parser für JavaScript (browser oder Knoten).

    oder bestätigen, dass eine Implementierung dieser Spezifikation produzieren würde, JSON, die gültig ist in Bezug auf Ihre JSON-schemas?

    In anderen Worten, hier einige JSON aus einer request-oder response-Körper, ist das korrekt?

    Swagger setzt auf einen anderen standard namens JSON-Schema für seine schema-Objekte, die was beschreibt eigentlich die JSON (eher als Endpunkte oder Metadaten). Swagger nutzt eine Teilmenge von JSON-Schema (fehlt: oneOf, patternProperties unter anderem). Zu diesem Zweck können Sie ein JSON-Schema-validator. Es gibt 37 hier aufgelistet; ich gebe ein shoutout diese online-validator, dass auch unterstützt YAML-schemas.

    Aber, wenn ich sagte, dass Swagger setzt auf eine Teilmenge der JSON-API, ich habe gelogen. Es gibt eine Handvoll von festen Feldern, die eine Besondere Bedeutung haben in Swagger, der nicht Teil des JSON-Schema. Einer von Ihnen ist discriminator das ist für die Polymorphie. Ich bin mir nicht bewusst eine Stolzieren validator verarbeiten kann discriminator. Es gibt eine ganze Reihe von Werkzeugen für swagger und einige behaupten, zu tun, Validierungen, aber viele sind abandonware, bedeutete für die alten Versionen, nicht feature-komplett, gebunden als andere Technologien, und so weiter. Wenn es eine ausgereifte und gut gepflegte Bibliothek, die mir fehlt, würde ich gerne wissen.

    Ich habe die gleiche situation und das war hilfreich. Mit einem bit der Arbeit, ich war in der Lage zu schreiben, meine eigenen Skripte, die überprüfen kann, ob mein server die response-payload mit der JSON-Schema definiert durch Angeberei. Ich schrieb einige Express-middlware zu tun. Anstatt zu versuchen, zu verwenden Swagger zu tun, was ich will, ich kann mit dem schema-Objekt darauf beruft. Danke!
    Für die zweite, wie würde ich das umsetzen, ohne dass ein externer schema-validator? Ich möchte nur zu überprüfen, die eine Instanz eines Schemas gegen ein (Fors) schema. Wie soll ich das tun? Danke.
    intern sieht es aus wie swagger ist mit dem z-schema, json validator, also theoretisch würden Sie schauen, um zu sehen, welche Funktionen sind verfügbar? github.com/zaggino/z-schema
    Hey Chris kannst du zeigen, wo swagger ist mit der z-schema?
    Diese Lösung ist nicht für mich gearbeitet. Absichtlich entfernt Pfad param-Deklaration und getestet. Es dauerte nicht beschweren, dass der Weg param verpasst. Es ist nur die Validierung der wohlgeformte json oder nicht.

    InformationsquelleAutor

  2. 1

    Wenn Ihr Swagger JSON gehostet wird, können Sie mit der folgenden url:
    http://online.swagger.io/validator/debug?url=your_url

    Das geht nur bei url ' s, die zugänglich sein können durch das internet. Dies funktioniert nicht für die Intranet-url ein.

    InformationsquelleAutor

  3. 0

    Die Open API 2.0 /Swagger-schema wird in ein paar Orte, es ist nur ein bisschen schwer zu finden wegen der starken Gebrauch von dem Wort 'schema' in Fors selbst.

    So können Sie eine generische Prüfung an diesem schema und Ihr Dokument. Zum Beispiel, dieses funktioniert gut für mich mit vscode und Red Hat die YAML extension.

    InformationsquelleAutor

Schreibe einen Kommentar