So generieren Sie swagger.json

8

Ich benutze java spring boot framework, um REST api für mein Projekt zu erstellen, und ich benutze "springfox-swagger2 und springfox-swagger-ui" für die Erzeugung von Swagger-Dokumentation. Ich kann meine Dokumentation mit der URL Ссылка sehen.

Wie kann ich swagger.json / spec.json erstellen / erzeugen? Die Dokumentation sollte nicht mit dieser Anwendung sein. Wir verwenden eine separate Anwendung zum Auflisten der api docs

    
Bikesh M Annur 23.01.2017, 14:16
quelle

4 Antworten

0

Ich habe das mit einem kleinen Trick gemacht

Ich habe den folgenden Code am Ende meines Home-Controller-Testfalls hinzugefügt

%Vor%

Ich weiß nicht, ob das richtig ist oder nicht Aber es funktioniert:)

Abhängigkeit

%Vor%     
Bikesh M Annur 30.11.2017, 09:28
quelle
7

Sie können die URL mit Ihrer swagger-ui html-Seite erhalten:

%Vor%

Und tatsächlich können Sie alle URLs mit der Toolfunktion chrome / firefox develop tools erhalten.

    
Liping Huang 24.01.2017 08:30
quelle
2

Ich bin etwas spät dran, aber ich habe gerade herausgefunden, dass Sie Ihre Browser-Konsole öffnen und die URL der GET-Anfrage finden können, die die JSON-Definition für Ihre Swagger-Dokumente zurückgibt. Die folgende Technik funktionierte bei der Zuordnung meiner API zu AWS API Gateway.

Um dies zu tun:

  1. Navigieren Sie zu Ihrem Swagger-Dokumentendpunkt
  2. Öffnen Sie die Browser-Konsole
  3. Aktualisieren Sie die Seite
  4. Navigieren Sie zur Registerkarte "Netzwerk" und filtern Sie nach XHR-Anforderungen
  5. Klicken Sie mit der rechten Maustaste auf die XHR-Anfrage, die in ?format=openapi endet
  6. Sie können das nun einfach kopieren und in eine neue JSON-Datei einfügen!
rlfrahm 07.08.2017 16:26
quelle
0

Wenn Sie Maven verwenden, können Sie mit swagger-maven Client- und Server-seitige Dokumentation (yaml, json und html) erstellen -Plugin

Fügen Sie dies Ihrer pom.xml hinzu:

%Vor%

Sie können die * .hbs-Vorlage unter folgender Adresse herunterladen: Ссылка

Führen Sie mvn swagger: generate aus Die JSon-Dokumentation wird in Ihrem Projekt / generated / swagger / -Verzeichnis generiert. Vorbei an dieser Adresse: Ссылка

Und generieren Sie, was immer Sie wollen (serverseitige oder clientseitige API in Ihrer bevorzugten Technologie)

    
MK-rou 24.01.2017 09:52
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset EditText in ListView mit windowSoftInputMode adjustPan