快捷導(dǎo)航

基于Rest的API解決方案(jersey與swagger集成)

更新時(shí)間：2017年08月01日 17:32:42 投稿：jingxian

下面小編就為大家?guī)?lái)一篇基于Rest的API解決方案(jersey與swagger集成)。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

一、項(xiàng)目目標(biāo)

動(dòng)靜分離的架構(gòu)，即客戶端和服務(wù)器端的分離，客戶端可以是IOS、android或者靜態(tài)的頁(yè)面。需要服務(wù)器端提供webservice服務(wù)，并且為了方便編寫api接口文檔，所以引入了swagger。

二、技術(shù)選型

為什么使用jersey而不用spring mvc

雖然spring-web提供了REST的功能，但是沒(méi)有實(shí)現(xiàn)JAX-RS的標(biāo)準(zhǔn)。

二、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 準(zhǔn)備

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

swagger其實(shí)就是一套靜態(tài)頁(yè)面，自定義了一套api的json格式，通過(guò)解析json將api展現(xiàn)出來(lái)。

下載之后將靜態(tài)頁(yè)面放在webapp目錄下即可，還需要改一下index.html中的url地址，改成本地的api接口地址即可。

3.2注冊(cè)

注冊(cè)swagger，即將swagger的rest服務(wù)注冊(cè)到j(luò)ersey中。

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

四、swagger集成過(guò)程中遇到的坑

4.1 jackson中報(bào)類型找不到，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中報(bào)的錯(cuò)誤

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}); 
 }

最終結(jié)果