一、項目目標
動靜分離的架構，即客戶端和服務器端的分離，客戶端可以是IOS、android或者靜態的頁面。需要服務器端提供webservice服務，并且為了方便編寫api接口文檔，所以引入了swagger。
二、技術選型
為什么使用jersey而不用spring mvc
雖然spring-web提供了REST的功能，但是沒有實現JAX-RS的標準。
二、maven配置
Java代碼
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
<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代碼
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
<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代碼
|
1
2
3
4
5
6
7
8
9
10
11
|
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代碼
|
1
2
3
4
5
6
7
8
9
10
11
12
|
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集成)就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支持服務器之家。
