Wie generiert man swagger.json mit Hilfe von Gradle?

Question

Wie generiert man swagger.json mit Hilfe von Gradle?

8

Ich möchte mit swagger-codegen REST-Clients und möglicherweise statische HTML-Dokumente generieren.

swagger-codegen benötigt jedoch swagger.json für die Eingabe.

Ich bin mir bewusst, dass ich dies von einem laufenden REST-Server mit Swagger erhalten kann.

Aber gibt es eine Möglichkeit, swagger.json direkt aus meinem Java-Code zu erhalten - also mit dem Quellcode aus dem Quellcode zu generieren - ohne die Anwendung in einem Webcontainer ausführen zu müssen und curl oder einen Browser anzuzeigen dazu?

java swagger swagger-codegen

tbsalling 21.09.2016, 12:07

quelle

2 Antworten

Tags und Links java swagger swagger-codegen

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Sellerie in der Flasche starten: AttributeError: 'Flask' Objekt hat kein Attribut 'user_options'

score 2 · Answer 1

Das ist ein bisschen alt, aber ich habe mich genauso gefragt ... Kurz gesagt habe ich mit der Forschung begonnen:

Eine Beispiel-Spring-Boot-App, die eine minimalistische REST-API anzeigt;
Swagger-Anmerkungen zu den API-Methoden;
Springfox;
Gradle als Build-Tool;

Ich habe es geschafft, die JSON-Spezifikation als Build-Artefakt zu erzeugen, indem ich zwei verschiedene Ansätze benutzte:

Durch Verwendung eines großen Ports von swagger-maven-plugin von kongchen .
(Nicht sicher, ob das zählt, weil es sowieso einen Server startet.) Durch Ausführen eines Integrationstests (Spring's Mock MVC), der die Spezifikation generiert. Ich habe die Idee von hier ausgeliehen.

Ich habe meine Forschung in einem einfachen Projekt hier zusammengefasst. Siehe den Abschnitt Automation . Code und Beispiele sind enthalten.

score 1 · Answer 2

Die Hauptidee ist, dass Sie swagger-maven-plugin und Ihre Java-Klassen in classpath für buildScript einfügen, damit Sie sie in der Klasse verwenden können, etwa so:

%Vor%

wobei die erste Zeile in den Abhängigkeiten swagger libs vom Unterprojekt erhält und die zweite Zeile Ihre Klassen, die swagger Anmerkungen enthalten sollen.

Danach können Sie maven plugin im Gradle als einfache Java-Klasse aufrufen:

%Vor%

Hier finden Sie dieses Beispiel.