Generierung von Rest-API-Dokumentation mit swagger oder einem anderen tool

Aktivieren swagger-ui verwenden, können Sie es "as-is" - aus der Dokumentation:

"Können Sie das swagger-ui-code IST! Keine Notwendigkeit, zu bauen oder
neu kompilieren-nur clone das repo und verwenden Sie die vorgefertigten Dateien in der
dist-Ordner. Wenn Sie wie swagger-ui-wie-ist, halt hier."

Also im Grunde müssten Sie nur die "dist" Inhalt in Ihrem web-server, dann geben Sie die swagger am Endpunkt Ihres web-service in der Benutzeroberfläche, zum Beispiel: http://localhost:8080/Webservice/api-doc.json (dies ist die gleiche Adresse, Endpunkt, den Sie haben, um zu definieren, in Ihrem web.xml).

Ich vermute, Sie haben einige andere details, die falsch konfiguriert, das ist einfach, da gibt es mehrere Orte, die Sie konfigurieren müssen Stolzieren. Im folgenden gebe ich Ihnen einige details von meinem eigenen setup in Fors.

Dies ist ein Ausschnitt von Fors Konfigurationen auf meinem web.xml:

<!-- //Jersey declaration -->
<servlet>
    <servlet-name>web service</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.mywebservice;com.wordnik.swagger.jaxrs.listing;com.fasterxml.jackson.jaxrs</param-value>
    </init-param>
    <init-param>
        <param-name>com.sun.jersey.config.property.classnames</param-name>
        <param-value>com.mywebservice;com.wordnik.swagger.jaxrs.listing;com.fasterxml.jackson.jaxrs</param-value>
    </init-param>
    <init-param>
        <param-name>swagger.api.basepath</param-name>
        <param-value>http://localhost:8080/Webservice</param-value>
    </init-param>
    <init-param>
        <param-name>api.version</param-name>
        <param-value>0.0.2</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet>
    <servlet-name>Bootstrap</servlet-name>
    <servlet-class>com.mywebservice.utils.swagger.Bootstrap</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<filter>
    <filter-name>ApiOriginFilter</filter-name>
    <filter-class>com.mywebservice.utils.swagger.ApiOriginFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>ApiOriginFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

Bellow ist eine Liste der com.mywebservice.utils.swagger Paket, wo es mehrere Ressourcen, wie Sie in der Fors-Dokumentation (die jetzt zu sein scheint, anders, als wenn ich es einrichten, so ist es hier die volle Liste der Dokumente):

Finden Sie diese Dateien (oder Beispiele) in dem Beispiel-Projekt von Swagger: https://github.com/wordnik/swagger-core/tree/master/samples/java-jaxrs, die Sie sollten versuchen, zu verwenden, als eine "Vorlage", um das setup Ihrer Angeberei. Die eine Datei hatte ich Probleme mit war die ApiListingResource:

import javax.ws.rs.Path;
import javax.ws.rs.Produces;

import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.jaxrs.JavaApiListing;

@Path("/resources.json")
@Api("/resources")
@Produces({ "application/json"})
public class ApiListingResource extends JavaApiListing{
}

HTH.