脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → jersey集成swagger

基于Rest的API解决方案(jersey与swagger集成)

 更新时间：2017年08月01日 17:32:42   投稿：jingxian  
下面小编就为大家带来一篇基于Rest的API解决方案(jersey与swagger集成)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧

一、项目目标

动静分离的架构，即客户端和服务器端的分离，客户端可以是IOS、android或者静态的页面。需要服务器端提供webservice服务，并且为了方便编写api接口文档，所以引入了swagger。

二、技术选型

为什么使用jersey而不用spring mvc

虽然spring-web提供了REST的功能，但是没有实现JAX-RS的标准。

二、maven配置

Java代码

<properties> 
 <jetty.version>8.1.16.v20140903</jetty.version> 
 <jersey.version>2.9</jersey.version> 
 <spring.version>4.0.1.RELEASE</spring.version> 
</properties> 
 
<dependency> 
 <groupId>io.swagger</groupId> 
 <artifactId>swagger-jersey2-jaxrs</artifactId 
 <version>1.5.9</version> 
 <exclusions> 
  <exclusion> 
   <groupId>javax.ws.rs</groupId> 
   <artifactId>jsr311-api</artifactId> 
  </exclusion> 
 </exclusions> 
</dependency> 
 
<dependency> 
 <groupId>org.glassfish.jersey.containers</groupId> 
 <artifactId>jersey-container-servlet</artifactId> 
 <version>${jersey.version}</version> 
</dependency> 
<dependency> 
 <groupId>org.glassfish.jersey.media</groupId> 
 <artifactId>jersey-media-json-jackson</artifactId> 
 <version>${jersey.version}</version> 
</dependency> 
<!-- jersey-spring --> 
<dependency> 
 <groupId>org.glassfish.jersey.ext</groupId> 
 <artifactId>jersey-spring3</artifactId> 
 <version>${jersey.version}</version> 
 <exclusions> 
  <exclusion> 
   <groupId>org.springframework</groupId> 
   <artifactId>spring-beans</artifactId> 
  </exclusion> 
  <exclusion> 
   <groupId>org.springframework</groupId> 
   <artifactId>spring-core</artifactId> 
  </exclusion> 
  <exclusion> 
   <groupId>org.springframework</groupId> 
   <artifactId>spring-web</artifactId> 
  </exclusion> 
 </exclusions> 
</dependency> 
还需要引入spring的包，作者使用的是4.0.1.RELEASE

三、swagger的操作

3.1swagger ui 准备

下载地址:https://github.com/swagger-api/swagger-ui

swagger其实就是一套静态页面，自定义了一套api的json格式，通过解析json将api展现出来。

下载之后将静态页面放在webapp目录下即可，还需要改一下index.html中的url地址，改成本地的api接口地址即可。

3.2注册

注册swagger，即将swagger的rest服务注册到jersey中。

register(io.swagger.jaxrs.listing.ApiListingResource.class);
register(io.swagger.jaxrs.listing.AcceptHeaderApiListingResource.class);
register(io.swagger.jaxrs.listing.SwaggerSerializers.class);

四、swagger集成过程中遇到的坑

4.1 jackson中报类型找不到，class java.lang.String

解决方法：更新jackson包

Java代码

<dependency> 
 <groupId>com.fasterxml.jackson.jaxrs</groupId> 
 <artifactId>jackson-jaxrs-json-provider</artifactId> 
 <version>2.7.4</version> 
</dependency> 
<dependency> 
 <groupId>com.fasterxml.jackson.jaxrs</groupId> 
 <artifactId>jackson-jaxrs-base</artifactId> 
 <version>2.7.4</version> 
</dependency> 
<dependency> 
 <groupId>com.fasterxml.jackson.core</groupId> 
 <artifactId>jackson-annotations</artifactId> 
 <version>2.7.4</version> 
</dependency> 
<dependency> 
 <groupId>com.fasterxml.jackson.datatype</groupId> 
 <artifactId>jackson-datatype-joda</artifactId> 
 <version>2.7.4</version> 
</dependency>

4.2 swagger-ui.js中报的错误

4.2.1 operation is null, 大概在2338行

Java代码

operation = path[method]; 
[b]if (operation === null) continue;[/b] 
var sharedParameters = path.parameters || []; 
var parameters = operation.parameters || []; 
for (i in sharedParameters) { 
 var parameter = sharedParameters[i]; 
 parameters.unshift(parameter); 
} 
if(method !== 'parameters' && _.isObject(operation)) { 
 operation.parameters = operation.parameters || parameters; 
}

4.2.2 enumValues is null, 大概在4383行

Java代码

if ([b]enumValues != null &&[/b] typeof enumValues !== 'undefined') { 
 var id; 
 param.allowableValues = {}; 
 param.allowableValues.values = []; 
 param.allowableValues.descriptiveValues = []; 
 for (id = 0; id < enumValues.length; id++) { 
 var value = enumValues[id]; 
 var isDefault = (value === param.default || value+'' === param.default); 
 param.allowableValues.values.push(value); 
 // Always have string for descriptive values.... 
 param.allowableValues.descriptiveValues.push({value : value+'', isDefault: isDefault}); 
 }

最终结果

以上这篇基于Rest的API解决方案(jersey与swagger集成)就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • vue3实现一个todo-list

    vue3实现一个todo-list

    这篇文章主要为大家详细介绍了基于vuejs实现一个todolist项目，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能给你带来帮助
    2021-08-08
  • 通过反射实现Java下的委托机制代码详解

    通过反射实现Java下的委托机制代码详解

    这篇文章主要介绍了通过反射实现Java下的委托机制代码详解，具有一定借鉴价值，需要的朋友可以参考下。
    2017-12-12
  • 关于Java中重定向传参与取值

    关于Java中重定向传参与取值

    这篇文章主要介绍了Java中重定向传参与取值问题,重定向不仅可以重定向到当前应用程序中的其他资源，还可以重定向到同一个站点上的其他应用程序中的资源，甚至是使用绝对URL重定向到其他站点的资源，本文给大家介绍的非常详细，需要的朋友可以参考下
    2023-05-05
  • 基于SpringBoot整合oauth2实现token认证

    基于SpringBoot整合oauth2实现token认证

    这篇文章主要介绍了基于SpringBoot整合oauth2实现token 认证,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • Java数据库连接池之c3p0简介_动力节点Java学院整理

    Java数据库连接池之c3p0简介_动力节点Java学院整理

    这篇文章主要为大家详细介绍了Java数据库连接池之c3p0简介的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-08-08
  • Spring事务失效问题分析及解决方案

    Spring事务失效问题分析及解决方案

    这篇文章主要介绍了Spring事务失效问题分析及解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • java 串口工具jSerialComm示例详解

    java 串口工具jSerialComm示例详解

    这篇文章主要介绍了java 串口工具jSerialComm,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2023-06-06
  • springboot controller参数注入方式

    springboot controller参数注入方式

    这篇文章主要介绍了springboot controller参数注入方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • PowerJob Alarmable工作流程源码剖析

    PowerJob Alarmable工作流程源码剖析

    这篇文章主要为大家介绍了PowerJob Alarmable工作流程源码剖析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • MyBatis-plus 模糊查询的使用

    MyBatis-plus 模糊查询的使用

    这篇文章主要介绍了MyBatis-plus 模糊查询的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09

最新评论