基于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集成)就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。

# jersey集成swagger  # 详解如何使用Jersey客户端请求Spring Boot(RESTFul)服务  # Jersey实现Restful服务(实例讲解)  # Java通过jersey实现客户端图片上传示例  # 使用CXF和Jersey框架来进行Java的WebService编程  # 基于JAVA中Jersey处理Http协议中的Multipart的详解  # 介绍Jersey-Jersey入门基础  # Java实现上传文件图片到指定服务器目录  # 使用Jersey构建图片服务器过程解析  # 给大家  # 还需要  # 的是  # 中报  # 客户端  # 放在  # 下载地址  # 找不到  # 希望能  # 自定义  # 后将  # 这篇  # 解决方法  # 小编  # 大家多多  # 过程中  # 文档  # 目录下  # 引入了  # jaxrs 

相关文章： 寿县云建站：智能SEO优化与多行业模板快速上线指南  宿州网站制作公司兴策,安徽省低保查询网站？  Python路径拼接规范_跨平台处理说明【指导】  javascript基本数据类型及类型检测常用方法小结  如何通过虚拟主机快速搭建个人网站？  ,在苏州找工作，上哪个网站比较好？  美食网站链接制作教程视频,哪个教做美食的网站比较专业点？  如何设计高效校园网站？  网站制作公司哪里好做,成都网站制作公司哪家做得比较好，更正规？  子杰智能建站系统｜零代码开发与AI生成SEO优化指南  c++23 std::expected怎么用 c++优雅处理函数错误返回【详解】  公众号网站制作网页,微信公众号怎么制作？  c++怎么编写动态链接库dll_c++ __declspec(dllexport)导出与调用【方法】  网站制作大概要多少钱一个,做一个平台网站大概多少钱？  如何做网站制作流程,*游戏网站怎么搭建？  专业公司网站制作公司,用什么语言做企业网站比较好？  简历在线制作网站免费版,如何创建个人简历？  网站制作服务平台,有什么网站可以发布本地服务信息？  陕西网站制作公司有哪些,陕西凌云电器有限公司官网？  建站主机选购指南：核心配置与性价比推荐解析  惠州网站建设制作推广,惠州市华视达文化传媒有限公司怎么样？  如何获取PHP WAP自助建站系统源码？  宁波免费建站如何选择可靠模板与平台？  活动邀请函制作网站有哪些,活动邀请函文案？  南平网站制作公司,2025年南平市事业单位报名时间？  建站之星2.7模板快速切换与批量管理功能操作指南  微信小程序 五星评分(包括半颗星评分)实例代码  宝塔建站助手安装配置与建站模板使用全流程解析  定制建站流程步骤详解：一站式方案设计与开发指南  Python文件管理规范_工程实践说明【指导】  如何高效搭建专业期货交易平台网站？  如何选择域名并搭建高效网站？  建站主机选虚拟主机还是云服务器更好？  PHP正则匹配日期和时间(时间戳转换)的实例代码  东莞市网站制作公司有哪些,东莞找工作用什么网站好？  如何在万网ECS上快速搭建专属网站？  企业网站制作费用多少,企业网站空间一般需要多大，费用是多少？  如何通过商城自助建站源码实现零基础高效建站？  网页设计网站制作软件,microsoft office哪个可以创建网页？  个人摄影网站制作流程,摄影爱好者都去什么网站？  如何用PHP快速搭建高效网站？分步指南  制作网站建设的公司有哪些,网站建设比较好的公司都有哪些？  专业网站制作服务公司,有哪些网站可以免费发布招聘信息？  如何选择服务器才能高效搭建专属网站？  香港服务器WordPress建站指南：SEO优化与高效部署策略  建站一年半SEO优化实战指南：核心词挖掘与长尾流量提升策略  外汇网站制作流程,如何在工商银行网站上做外汇买卖？  建站之星微信建站一键生成小程序+多端营销系统  Python多线程使用规范_线程安全解析【教程】  如何选择高效可靠的多用户建站源码资源？