将Swagger-UI添加到Jersey JAX-RS Web应用程序中的步骤如下:
src/main/webapp/swagger-ui
。web.xml
文件中添加以下Servlet配置,以将Swagger-UI映射到特定的URL路径:<servlet>
<servlet-name>SwaggerUI</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.json;io.swagger.jaxrs.listing</param-value>
</init-param>
<init-param>
<param-name>jersey.config.server.provider.classnames</param-name>
<param-value>org.glassfish.jersey.jackson.JacksonFeature</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>SwaggerUI</servlet-name>
<url-pattern>/api-docs/*</url-pattern>
</servlet-mapping>
pom.xml
文件中包含以下Swagger和Jersey相关的依赖项:<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-jersey2-jaxrs</artifactId>
<version>2.1.5</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-json-jackson</artifactId>
<version>2.33</version>
</dependency>
http://your-app-url/api-docs
来查看Swagger-UI界面,并浏览和测试你的API文档。请注意,以上步骤假设你正在使用Jersey作为JAX-RS实现,并且已经正确配置了Swagger依赖项。如果你使用的是其他JAX-RS实现或不同的构建工具,请相应地调整步骤。
推荐的腾讯云相关产品:腾讯云API网关(https://cloud.tencent.com/product/apigateway)可以帮助你更好地管理和发布API,并提供了丰富的API文档和调试工具。
领取专属 10元无门槛券
手把手带您无忧上云