7
So generieren Sie eine JSON-Datei aus Java-Dateien mit Swagger-spezifischen Anmerkungen, sodass Swagger-UI sie lesen kann.Wie Java Swagger Annotation in Swagger JSON Schema konvertieren?
A
Antwort
1
Wie Sie sagen: „Ich will nicht, es zu tun manuell“, verwenden Sie die Swagger Maven Plugin:
<plugin>
<groupId>com.github.kongchen</groupId>
<artifactId>swagger-maven-plugin</artifactId>
<version>3.1.4</version>
<configuration>
<apiSources>
<apiSource>
<springmvc>true/false</springmvc>
<locations>
<location>com.yourpackage.something</location>
</locations>
<host>yourhost.com</host>
<basePath>/some/path</basePath>
<info>
<title>Your Project Title</title>
<version>${project.version}</version>
<description>Some nice stuff</description>
<termsOfService>...</termsOfService>
<contact>
<email>[email protected]</email>
<name>Your Name</name>
<url>www.where.to.find.you</url>
</contact>
</info>
<swaggerDirectory>path/to/swagger/output</swaggerDirectory>
<outputFormats>json</outputFormats>
</apiSource>
</apiSources>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
Dann können Sie mvn compile tun und es wird die swagger.json Datei generieren.
Schauen Sie sich die Beispiele im [swagger-samples] (https://github.com/swagger-api/swagger-samples) -Repository an, die zeigen, wie dies gemacht wird. Es hängt von einer Reihe von Dingen ab, einschließlich Ihres Frameworks usw. – fehguy
Ich verwende Java und SpringBoot für das Framework. –
In Swagger-Samples Repo wird der Swagger JSON manuell erstellt, nehme ich an. Ich möchte es nicht manuell machen. –