文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

使用Rest如何对API进行处理

2023-05-31 08:20

关注

这篇文章给大家介绍使用Rest如何对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进行处理就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯