标签:restful
(1)整理项目需求,编写Api需求文档,包括Api返回结果,查询参数等等。
(2)定义RestFul Api接口。
(3)测试RestFul Api接口。
(4)编写Api说明文档,包括Api的名称,路径,Http方法,请求参数,功能模板,返回结果等等,方便各模块研发人员和测试人员使用。
(5)测试人员测试Api,主要测试系统性能,还有一些特出场景测试,例如多线程,并发操作。编写Api测试报告
(6)Api接口调用,项目研发阶段。
备注:上述5和6可以同时进行,互不影响。主要产生三个Api文档:需求文档,说明文档,测试文档。
这里我总结一下2和3定义和测试RestFul api的一些经验,有疑问或者补充的地方请大家不吝赐教!
一:定义RestFul api
(1)api路径
之前在项目中定义Api,犯了一个很严重的问题。没有遵守RestFul规范,Api资源路径中还有大量的动词。
在RESTful架构中,每个url代表一种资源(resource),所以网址中不能有动词,只能有名词。
例如:获取产品的API可以这样定义
获取单个产品:http://127.0.01:8080/AppName/rest/product/1
获取多个产品: http://127.0.01:8080/AppName/rest/products
(2)Http方法
常用的HTTP动词有下面四个(括号里是对应的SQL命令)。
GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
DELETE(DELETE):从服务器删除资源。
标签:restful
原文地址:http://blog.csdn.net/u013628152/article/details/42174469