eclipse - Jersey + Swagger + Swagger-UI + Maven 配置

Question

我第一次尝试使用 Jersey 和 Maven 进行 Swagger ，我想知道我是否走在正确的道路上。我的本地计算机上有 jersey、maven 和 swagger。很快，我想将其部署到不同的环境并包含 swagger-ui。

1. 如果我将 web.xml 文件配置为 <param-value>http://localhost:8080/api</param-value>然后我看到 swagger 在我的本地计算机上运行。但是，每次我想将代码部署到不同的环境(例如从开发环境，到质量检查环境，再到生产环境)时，我是否需要更改此地址，如果是这样，我将如何去做呢？不可能/不是 swagger 的目的吗？

2. 我想将 swagger-ui 合并到我的项目中。我看到网上建议从 git 手动下载文件并将其放入我的项目中。但我想知道是否有一个我可以使用的 Maven 依赖项，以便我可以使用 Maven 获取使用 swagger-ui 所需的代码并将其配置为与 jersey 一起使用。如果是这样，依赖项是什么以及如何使用它通过多个环境部署代码？

如果可能的话，请提供指导和教程链接，因为我是这项技术的新手。另外，如果我在使用 jersey/swagger/swagger-ui/maven 的思维过程中偏离了方向，而没有从 git 手动下载代码并且能够通过多个环境部署代码，请告诉我，以便我可以寻找另一种使用方法在我的应用程序中休息。

感谢您的帮助。

pom.xml:

    <repositories>
      <repository>
          <id>maven2-repository.java.net</id>
          <name>Java.net Repository for Maven</name>
          <url>http://download.java.net/maven/2/</url>
          <layout>default</layout>
      </repository>
  </repositories>

  <properties>
      <jersey2.version>2.19</jersey2.version>
      <jaxrs.version>2.0.1</jaxrs.version>
  </properties>

  <!-- Dependencies -->
  <dependencies>


    <!-- JAX-RS -->
    <dependency>
        <groupId>javax.ws.rs</groupId>
        <artifactId>javax.ws.rs-api</artifactId>
        <version>${jaxrs.version}</version>
    </dependency>
    <!-- Jersey 2.19 -->
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet</artifactId>
        <version>${jersey2.version}</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-server</artifactId>
        <version>${jersey2.version}</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-client</artifactId>
        <version>${jersey2.version}</version>
    </dependency>

     <!-- Servlet Library -->
     <!-- http://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
     <dependency>
         <groupId>javax.servlet</groupId>
         <artifactId>javax.servlet-api</artifactId>
         <version>3.1.0</version>
         <scope>provided</scope>
     </dependency>

     <!-- Spring dependencies -->
     <!-- http://mvnrepository.com/artifact/org.springframework/spring-core -->
     <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-core</artifactId>
         <version>4.1.4.RELEASE</version>
     </dependency>

     <!-- http://mvnrepository.com/artifact/org.springframework/spring-web -->
     <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-web</artifactId>
         <version>4.1.4.RELEASE</version>
     </dependency>

     <!-- http://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
     <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-webmvc</artifactId>
         <version>4.1.4.RELEASE</version>
     </dependency>

    <!-- Junit -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-jersey2-jaxrs</artifactId>
        <version>1.5.0</version>
    </dependency>
  </dependencies>

web.xml

    <?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns="http://java.sun.com/xml/ns/javaee"
  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
  id="WebApp_ID" version="3.0">

  <display-name>HelloWorldSpring</display-name>

  <servlet>
      <servlet-name>spring-mvc</servlet-name>
      <servlet-class>
          org.springframework.web.servlet.DispatcherServlet
      </servlet-class>
      <load-on-startup>1</load-on-startup>
  </servlet>    

  <servlet-mapping>
      <servlet-name>spring-mvc</servlet-name>
      <url-pattern>/</url-pattern>
  </servlet-mapping>

  <servlet>
      <servlet-name>jersey-serlvet</servlet-name>
      <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
      <init-param>
           <param-name>jersey.config.server.provider.packages</param-name>
           <param-value>
           io.swagger.jaxrs.listing, 
           com.jer.rest
           </param-value>
      </init-param>
      <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
      <servlet-name>jersey-serlvet</servlet-name>
      <url-pattern>/rest/*</url-pattern>
  </servlet-mapping>


   <servlet>
      <servlet-name>Jersey2Config</servlet-name>
      <servlet-class>io.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>http://localhost:8080/HealthTracker/rest</param-value>
      </init-param>
      <load-on-startup>2</load-on-startup>
  </servlet>

   <!-- Other XML Configuration -->
  <!-- Load by Spring ContextLoaderListener -->
  <context-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>/WEB-INF/root-context.xml</param-value>
  </context-param>


   <!-- Spring ContextLoaderListener -->
  <listener>
      <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>

</web-app>

Answer 1

查看链接https://github.com/swagger-api/swagger-samples/tree/2.0/java

它提供了有关如何在项目中配置 Swagger 3.0 的优秀示例(请参阅 java-jersey2-webxml 示例)。对于早期版本，请检查分支

就 ui 而言，您可以下载所需的文件，也可以在 pom.xml 中添加以下依赖项。

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>swagger-ui</artifactId>
    <version>3.6.1</version>
</dependency>

它将下载必要的 ui 文件。您可以将下载的index.html复制到您的项目中并编辑url。