Wie integrieren Swagger mit Maven + Java + Jersey +Tomcat
Ich kann nicht scheinen, um zu verstehen, wie zu integrieren Swagger zum generieren der API-Dokumentation.
url: ####:8080/MyService/rest/users/getall
Ich habe Anmerkungen zu code und der Abhängigkeit.
Ich versuche, besuchen Sie: ####:8080/MyService/rest/aber sagt, seine nicht gefunden.
//web.xml
<servlet>
<servlet-name>mycompany-users-serlvet</servlet-name>
<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>com.sun.jersey.config.property.packages</param-name>
<param-value>com.users.services.mycompany,com.wordnik.swagger.jersey.listing</param-value>
</init-param> `
<servlet>
<servlet-name>JerseyJaxrsConfig</servlet-name>
<servlet-class>com.wordnik.swagger.jersey.config.JerseyJaxrsConfig</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>####:8080/MyService/rest/</param-value> //not sure What this should be?
</init-param>
<load-on-startup>2</load-on-startup>`
Du musst angemeldet sein, um einen Kommentar abzugeben.
Vorausgesetzt, dass Sie korrekt kopiert die Dateien aus https://github.com/wordnik/swagger-ui zu Ihrem Projekt (Verzeichnis
dist
kopiert werden müssen, um Ihresrc/main/webapp
), dann können Sie den Zugriff auf die API-Dokumentation aufhttp://.../MyService/index.html
. Vergessen Sie nicht, zu ändernindex.html
so, dass Swagger weiß, wo laden Sie die API-docs:Den API-Basis-Pfad in Ihre
web.xml
musshttp://.../MyService/rest
wennrest
ist der Pfad der Anwendung, die Sie definiert haben, in Ihrer Implementierung der Klassejavax.ws.rs.core.Application
durch den Vermerk@ApplicationPath
.Hier ist ein Beispiel von dem, was ich normalerweise tun (ich benutze keine
web.xml
für Konfiguration):Hier ist das einfachste Beispiel mit spring, tomcat, jersey, maven, swagger.
Unten ist die Struktur des Projektes.
Code für HelloWorldService.
SwaggerApp.class
applicationContext.xml
Web.xml
pom.xml
Nach der Einstellung des Projekts. Erstellen Sie und implementieren Sie die war-Datei im Tomcat-webapps-Ordner.
Führen Sie Tomcat und trifft unten Links :
http://localhost:8080/jax-rs/rest/api-docs
Für swagger-ui
http://localhost:8080/jax-rs
Fühlen Sie sich frei, zu Fragen Sie im Falle von Rückfragen.
Unten ist der link zum Quellcode :
https://github.com/neeraj179/euler/tree/master/swagger
Den
swagger.api.basepath
parameter ist nicht, wo Ihre Swagger installation hält derindex.html
. Es ist ein parameter, der Swagger verwendet, um Ihnen die Fähigkeit zu rufen, Ihre REST-Endpunkten über das Swagger UI, also es wird gerendert, in die links Swagger nutzt.Laden Sie die Swagger-UI und legen Sie Sie in Ihre
WebContent
Ordner. Sie können dann laden Sie die Swagger UI beihttp://localhost:8080/swagger/
.Den
web.xml
sollte wie folgt Aussehen: