Generieren Sie API-Dokumentation über Swagger auf Javax (unter JEE)?

Question

G'Evening,

Wir versuchen Swagger in ein bestehendes REST-Projekt zu implementieren, das auf einem Wildfly mit Java EE läuft. Der Zweck ist, die Dokumentation für die REST-API zur Laufzeit zu generieren.

jedoch nach den erforderlichen Abhängigkeiten Zugabe (io.swagger: swagger-jaxrs) zu unserem Gradle Setup haben wir versucht, den Swagger Generator über die web.xml

<servlet-mapping> 
<servlet-name>SwaggerConfig</servlet-name> 
<url-pattern>/api/documentation</url-pattern> 
</servlet-mapping> 

<servlet> 
<servlet-name>SwaggerConfig</servlet-name> 
<servlet-class>io.swagger.jaxrs.config.DefaultJaxrsConfig</servlet-class> 
<init-param> 
<param-name>api.version</param-name> 
<param-value>1.0.0</param-value> 
</init-param> 
<init-param> 
<param-name>swagger.api.basepath</param-name> 
<param-value>http://localhost:8080/api/documentation</param-value> 
</init-param> 
<load-on-startup>2</load-on-startup> 
</servlet> 

Wir Einrichtung verwalte die Adresse Servlet unter */api/Dokumentation über SOAP, aber es scheint keine Dokumentation, JSON-Datei oder andere, generiert zu werden, noch scheinen wir in der Lage zu sein, herauszufinden, wo/wie die Generation einzurichten ist.

Jede Hilfe, Beratung oder ein Link zu einem Leitfaden, den wir möglicherweise verpasst haben, wäre sehr willkommen.

Answer 1

Swagger generiert eine HTML-Seite, auf die zugegriffen werden kann, während der Back-End-Server ausgeführt wird.

Versuchen /api/index.html