這篇文章給大家介紹使用Rest如何對(duì)API進(jìn)行處理,內(nèi)容非常詳細(xì),感興趣的小伙伴們可以參考借鑒,希望對(duì)大家能有所幫助。
南湖ssl適用于網(wǎng)站、小程序/APP、API接口等需要進(jìn)行數(shù)據(jù)傳輸應(yīng)用場(chǎng)景,ssl證書(shū)未來(lái)市場(chǎng)廣闊!成為創(chuàng)新互聯(lián)的ssl證書(shū)銷(xiāo)售渠道,可以享受市場(chǎng)價(jià)格4-6折優(yōu)惠!如果有意向歡迎電話聯(lián)系或者加微信:028-86922220(備注:SSL證書(shū)合作)期待與您的合作!一、項(xiàng)目目標(biāo)
動(dòng)靜分離的架構(gòu),即客戶端和服務(wù)器端的分離,客戶端可以是IOS、android或者靜態(tài)的頁(yè)面。需要服務(wù)器端提供webservice服務(wù),并且為了方便編寫(xiě)api接口文檔,所以引入了swagger。
二、技術(shù)選型
為什么使用jersey而不用spring mvc
雖然spring-web提供了REST的功能,但是沒(méi)有實(shí)現(xiàn)JAX-RS的標(biāo)準(zhǔn)。
二、maven配置
Java代碼
8.1.16.v20140903 2.9 4.0.1.RELEASE io.swagger swagger-jersey2-jaxrs 1.5.9javax.ws.rs jsr311-api org.glassfish.jersey.containers jersey-container-servlet ${jersey.version} org.glassfish.jersey.media jersey-media-json-jackson ${jersey.version} 還需要引入spring的包,作者使用的是4.0.1.RELEASE org.glassfish.jersey.ext jersey-spring3 ${jersey.version} org.springframework spring-beans org.springframework spring-core org.springframework spring-web
三、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)類(lèi)型找不到,class java.lang.String
解決方法:更新jackson包
Java代碼
com.fasterxml.jackson.jaxrs jackson-jaxrs-json-provider 2.7.4 com.fasterxml.jackson.jaxrs jackson-jaxrs-base 2.7.4 com.fasterxml.jackson.core jackson-annotations 2.7.4 com.fasterxml.jackson.datatype jackson-datatype-joda 2.7.4
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}); }
關(guān)于使用Rest如何對(duì)API進(jìn)行處理就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò),可以把它分享出去讓更多的人看到。