欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2023-12-20 11:50:52
一、项目目标 动静分离的架构,即客户端和服务器端的分离,客户端可以是ios、android或者静态的页面。需要服务器端提供webservice服务,并且为了方便编写api...

一、项目目标

动静分离的架构,即客户端和服务器端的分离,客户端可以是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集成)

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

上一篇:

下一篇: