❶ 如何设计好的RESTful API 之好的RESTful API 特征
一个好的RESTful API,应该具备以下特征:
这个API应该是对浏览器友好的,能够很好地融入Web,而不是与Web格格不入。
1.浏览器是最常见和最通用的REST客户端。好的RESTful API应该能够使用浏览器+HTML完成所有的测试(不需要使用编程语言)。这样的API还可以很方便地使用各种自动化的Web功能测试、性能测试工具来做测试。Web前端应用(基于浏览器的RIA应用、移动App等等)也可以很方便地将多个RESTful API的功能组合起来,建造Mashup类的应用。
这个API中所包含的资源和对于资源的操作,应该是直观和容易理解的,并且符合HTTP协议的要求。
REST开发又被称作“面向资源的开发”,这说明对于资源的抽象,是设计RESTful API的核心内容。RESTful API建模的过程与面向对象建模类似,是以名词为核心的。这些名词就是资源,任何可命名的抽象概念都可以定义为一个资源。而HTTP协议并不是一种传输协议,它实际提供了一个操作资源的统一接口。对于资源的任何操作,都应该映射到HTTP的几个有限的方法(常用的有GET/POST/PUT/DELETE四个方法,还有不常用的PATCH/HEAD/OPTIONS方法)上面。所以RESTful API建模的过程,可以看作是具有统一接口约束的面向对象建模过程。
按照HTTP协议的规定,GET方法是安全且幂等的,POST方法是既不安全也不幂等的(可以用来作为所有写操作的通配方法),PUT、DELETE方法都是不安全但幂等的。将对资源的操作合理映射到这四个方法上面,既不过度使用某个方法(例如过度使用GET方法或POST方法),也不添加过多的操作以至于HTTP的四个方法不够用。
2.如果发现资源上的操作过多,以至于HTTP的方法不够用,应该考虑设计出更多的资源。设计出更多资源(以及相应的URI)对于RESTful API来说并没有什么害处。
这个API应该是松耦合的。
RESTful API的设计包括了三个循序渐进、由低到高的层次:资源抽象、统一接口、超文本驱动。正是这三个层次确保了RESTful API的松耦合性。
3.当设计面向互联网的API时,松耦合变成了一种“必须有”的强需求。紧耦合的API非常脆弱,一旦公布出去,服务器端和客户端都无法持续进化。尤其是服务器端,公布出去的接口根本不敢改,改了之后,几乎所有客户端应用立即无法正常工作。REST这种架构风格就是紧耦合API的解毒剂,这个话题可以谈的很深,这里就不展开了。感兴趣的读者可以参考《REST实战》。
这个API中所使用的表述格式应该是常见的通用格式
在RESTful API中,对于资源的操作,是通过在服务器端-客户端之间传递资源的表述来间接完成的。资源的表述可以有很多种格式,并且在响应和请求中的资源表述格式也会有所不同。GET/POST响应中的资源表述格式,常见的有HTML、XML、JSON;POST/PUT请求中的资源表述格式,常见的有标准的HTML表单参数、XML、JSON。
4.这些常见表述格式,处理起来非常容易,有大量的框架和库提供支持。所以除非有很合理的要求,通常不需要使用自定义的私有格式。
使用HTTP响应状态代码来表达各种出错情况
HTTP响应状态代码,是HTTP协议这个统一接口中用来表达出错情况的标准机制。响应状态代码分成两部分:status code和reason phase。两部分都是可定制的,也可以使用标准的status code,只定制reason phase。
5.如果一个所谓的“RESTful API”对于任何请求都返回200 OK响应,在响应的消息体中返回出错情况信息,这种做法显然不符合“确保操作语义的可见性”这个REST架构风格的基本要求。
这个API应该对于HTTP缓存是友好的
6.充分利用好HTTP缓存是RESTful API可伸缩性的根本。HTTP协议是一个分层的架构,从两端的user agent到origin server之间,可以插入很多中间组件。而在整个HTTP通信链条的很多位置,都可以设置缓存。HTTP协议内建有很好的缓存机制,可以分成过期模型和验证模型两套缓存机制。如果API设计者完全没有考虑过如何利用HTTP缓存,那么这个API的可伸缩性会有很多问题。
❷ 如何处理高并发的RESTful接口
现在有一个系统,他有两个接口并发量特别高,或者说比其他接口高出几个档次。
那么如何针对这两个接口进行处理?
目前我有几点疑惑。
1、不少高并发网站在指出将模块服务化,这样可以对各个模块进行负载均衡,按需分配,那么他其实是代码层级上就是分开编写的还是只是部署在不同的机器上用nginx转发实现模块化?
2、如果代码不是分开编写的,像这种个别接口访问量高的应该怎么处理。
3、就算是分开编写,每个服务已经自成一个系统,那么如何处理该系统中极个别接口访问量特别高的情况?
现在想到的方法是:
使用nginx负载均衡,针对这两个接口给予专门的服务器集群做处理(代码还是那一套)。
我不知道这样做是不是正确的?因为我为了这两个接口部署了整个系统,我感觉是有问题的。
❸ restful web service 在大数据量下一般是怎么分页的
我发现,现在人们不再使用“Web Service”这一词汇了,人人使用“API”。
恐怕现在说“人们不再使用这个词汇了”还为时尚早,毕竟还是有很多地方使用它,如云和移动计算,Cloud IDE,以及社交网络等还在使用该词汇。Leonard的观点应该是“这个词汇不再像以前用得那么频繁了”。
我注意到,人们所使用的词汇呈现交替现象,而现在“Web Service”一词已几乎匿迹了。当我说“Web Service”的时候,人们知道我在说什么,但是这让我感觉自己“Out了!”就像执拗地在漫天“开源”的世界里使用“免费软件”一词。
他问到,这一微妙变化是否意味着业界一些根本性的、重要的事情的发生呢?同时,众所周知,REST支持者口中的”Web Service”是有别于SOAP社区所说的Web Service。那么,这些变化仅在REST社区发生吗?SOAP社区中“Web Service”一词使用频率的下降与WS-*使用的明显下降能够简单地挂上钩吗?
不过,Leonard担心这种变化会不会带来问题?
[我相信]人们在2007年左右不再说“Web Service”是有原因的,但是,将“API”作为一个通用的词汇将会导致软件产品的向更糟糕的方向发展。[……]
那么,“Web Service”一词真正消亡了?被“API”取代了?如果答案是肯定的,那么其隐含着什么呢?会不会因为“API”一词在Web中(可能)带来的混淆而导致软件实现更差呢?Leonard此文的一条评论说到:
我认为,API不能自描述。明显,并非所有的Web Service能做到这一点,但是至少它们有专门用于描述的标准格式。拿我经历的一件有趣的事来说吧,最近一家客户聘请我们使用其Web Service(不是API)开发一个应用。它们是SOAP,却是巴洛克式的,晦涩难懂。他们为何称其为“Web Service”而非“API”也许有其自己的理由。但是,我的确看到很多网站毫不遮掩地吹嘘他们的API。
所以,不存在绝对的黑与白,很多东西游走于中间的灰色地带。
❹ 如何理解rest和restful,什么是restfulAPI
简单理解一
就是用URL定位资源,用HTTP描述操作。
简单理解二
URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作。
官方定义
一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。
以web开发举例
在设计web接口的时候,REST主要是用于定义接口名,接口名一般是用名次写,不用动词,那怎么表达“获取”或者“删除”或者“更新”这样的操作呢——用请求类型来区分。
比如,我们有一个students接口,对于“学生”我们有增删改查四种操作,怎么定义REST接口?
增加一个学生,uri: http://testcode.com/school/students 接口类型:POST
删除一个朋友,uri: http://testcode.com/school/students 接口类型:DELETE
修改一个朋友,uri: http://testcode.com/school/students 接口类型:PUT
查找朋友,uri: http://testcode.com/school/students 接口类型:GET
上面我们定义的四个接口就是符合REST协议的,请注意,这几个接口都没有动词,只有名词students,都是通过Http请求的接口类型来判断是什么业务操作。
举个反例
uri: http://testcode.com/school/addStudents 该接口用来表示增加学生,这就是不符合REST协议的接口。
建议
用HTTP Status Code传递Server的状态信息。比如最常用的 200 表示成功,500 表示Server内部错误,403表示Bad Request等。(反例:传统web开发返回的状态码一律都是200,其实不可取。)
REST风格接口意义
前后端分离。前端拿到数据只负责展示和渲染,不对数据做任何处理。后端处理数据并以JSON格式传输出去,定义这样一套统一的接口,在web,ios,android三端都可以用相同的接口,节约开发成本以及便于同一调试。
❺ restful api 一般怎么测试
定义了RestFul Api,必须先做单元测试,确保Api可用,然后再交给别人去调用,这样才能确保工作进度
(1)使用Apache的jmeter测试工具,很方便,可以批量测试Api,
(2) 使用JerseyClient写测试程序。因为我们用的是jersey实现的RestFul。
(3) 使用浏览器插件工具,我用的是火狐的插件RESTClient
(4)使用curl命令行工具。
使用工具测试Api,GET方法还好,如果是POST方法需要指定方法的Headers(数据格式),Body(请求参数),Api的url。
Body请求参数,如何获取呢,在这里我使用了Gson,先用java组织参数对象,然后用Gson将参数对象转化为json串。
Gson gson = new Gson();
String wqtString = gson.toJson(wqt);
System.out.println(wqtString)
举例说明:
我们框架中封装了一个查询参数WebQueryTerm。我获取到它的json串格式为:
{"page":{"number":1,"size":10,"total":0,"sorts":[{"field":"creationTime","type":"DESC"}]},"terms":[{"field":"appType","operator":"equal","value":"0"}]}
其中
page表示分页属性。number当前页,size一页显示多少条数据,
sorts排序:field表示排序字段。type表示排序类型,是desc降序还是asc升序
terms表示查询。field表示查询字段;operator表示是模糊查询Like还是精确查询Equal,value表示你输入的查询值。
追答
这里简单说一下,怎么使用火狐的RESTClient。
(1)首先,在火狐浏览器菜单-附件组件-插件,中搜索RESTClient,并安装
(2)打开RESTClient,点击菜单Headers。输入自定义Request Headers。例如Name = Content-Type Value=application/json 点击okay!
(3)选择Method,我选择Post,因为我测试获取应用列表,带分页,带查询条件。
(4)输入api资源的url:http://192.168.1.183:8080/osd/rest/app/get_app_list
(5)输入上面的请求参数json串。
(6)点击Send请求API。
结果查看:Response Headers如果Status Code =200 ok则表明API没有异常
再看Response Body返回数据,是否满足你的要求。测试工作完成!
❻ restful api接口规范是什么
REST(REpresentationStateTransfer)描述了一个架构样式的网络系统,比如web应用程序。
一般依赖于HTTP认证,HTTP认证有几种:basic,digest,token,这些都有标准的实现的开源包需要主要的是这个认证的帐号跟你业务的帐户实际是不一样的。REST属于webService一种,安全是后台服务的安全,因此不需要实际的业务帐号,通常是系统keyStore证书库里的账户。
RESTFUL特点包括:
1、每一个URI代表1种资源。
2、客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。
3、通过操作资源的表现形式来操作资源。
4、资源的表现形式是XML或者HTML。
5、客户端与服务端之间的交互在请求之间是无状态的,从客户端到服务端的每个请求都必须包含理解请求所必需的信息。
❼ 关于网站页面访问量统计的问题
技术问题,还是去技术论坛吧
关于页面刷新后不会自动+1,指的是页面短期内一直刷新在同一个浏览器刷新不会被记录,在不同电脑一定间隔时间后点击该页面可以被记录
关于这个需求,你又不是做投票软件,记录用户ip地址,用户刷新一次或点击就算一次点击,不用做的这么精确吧!
一般统计网页程序,都是内嵌js脚本,你建立一个用于统计的js公用文件,然后需要统计的页面都引用他。
请参考Piwik
<!--LoadPiwik.-->
<scripttype="text/javascript">
document.write(unescape("%3Cscriptsrc='"+(("https:"==document.location.protocol)?"https://demo2.piwik.org/":"http://demo2.piwik.org/")+"piwik.js'type='text/javascript'%3E%3C/script%3E"));
</script><scripttype="text/javascript">
try{
varpiwikTracker=Piwik.getTracker((("https:"==document.location.protocol)?"https://demo.piwik.org/":"http://demo.piwik.org/")+"piwik.php",1);
piwikTracker.setCookieDomain('*.piwik.org');
if(document.domain!='piwik.org'){
piwikTracker.setDocumentTitle(document.domain+"/"+document.title);
}
//,intheCustomVariable
if(!piwikTracker.getCustomVariable(1)){
piwikTracker.setCustomVariable(1,"Domainlanded",document.domain);
}
piwikTracker.trackPageView();
piwikTracker.enableLinkTracking();
}catch(err){}
</script><noscript><p><imgsrc="http://demo.piwik.org/piwik.php?idsite=1"style="border:0"alt=""/></p></noscript>
<!--EndPiwikTag-->
每次页面加载完毕,js就往你后台发一个请求,这个请求包含了,比如说客户端访问的url,然后d电脑分辨率啊什么的,到服务器端,你能得到ip地址,解析一下http请求头,也能得到一些信息。
然后记录下来。
❽ 如何使用RestTemplate访问restful服务
一. 什么是RestTemplate
传统情况下在Java代码里访问restful服务,一般使用Apache的HttpClient。不过此种方法使用起来太过繁琐。spring提供了一种简单便捷的模板类来进行操作,这就是RestTemplate。
二、举个例子。 //请求地址
String url = "http://localhost:8080/testPost";
//入参
RequestBean requestBean = new RequestBean();
requestBean.setTest1("1");
requestBean.setTest2("2");
requestBean.setTest3("3");
RestTemplate restTemplate = new RestTemplate();
ResponseBean responseBean = restTemplate.postForObject(url, requestBean, ResponseBean.class);
从这个例子可以看出,使用restTemplate访问restful接口非常的简单粗暴无脑。(url,
requestMap, ResponseBean.class)这三个参数分别代表 请求地址、请求参数、HTTP响应转换被转换成的对象类型。
RestTemplate方法的名称遵循命名约定,第一部分指出正在调用什么HTTP方法,第二部分指示返回的内容。本例中调用了restTemplate.postForObject方法,post指调用了HTTP的post方法,Object指将HTTP响应转换为您选择的对象类型。
三.手动指定转换器(HttpMessageConverter)
我们知道,调用reseful接口传递的数据内容是json格式的字符串,返回的响应也是json格式的字符串。然而restTemplate.postForObject方法的请求参数RequestBean和返回参数ResponseBean却都是java类。是RestTemplate通过HttpMessageConverter自动帮我们做了转换的操作。
默认情况下RestTemplate自动帮我们注册了一组HttpMessageConverter用来处理一些不同的contentType的请求。
如StringHttpMessageConverter来处理text/plain;来处理application/json;来处理application/xml。
你可以在org.springframework.http.converter包下找到所有spring帮我们实现好的转换器。
如果现有的转换器不能满足你的需求,你还可以实现org.springframework.http.converter.HttpMessageConverter接口自己写一个。
四.设置底层连接方式
要创建一个RestTemplate的实例,您可以简单地调用默认的无参数构造函数。这将使用java.NET包中的标准Java类作为底层实现来创建HTTP请求。
但很多时候我们需要像传统的HttpClient那样设置HTTP请求的一些属性。RestTemplate使用了一种很偷懒的方式实现了这个需求,那就是直接使用一个HttpClient作为底层实现......
五.设置拦截器(ClientHttpRequestInterceptor)
有时候我们需要对请求做一些通用的拦截设置,这就可以使用拦截器进行处理。拦截器需要我们实现org.springframework.http.client.ClientHttpRequestInterceptor接口自己写。
以上是如何使用RestTemplate方便快捷的访问restful接口。其实RestTemplate的功能非常强大