【接口测试】3_接口测试基础 _RESTful接口规范

一、传统接口风格

1.1 传统接口风格特性

1、请求方法，只使用 get 和 post 即可。

2、URL 不唯一。同一个操作可以对应不同的 URL

3、状态码的使用较单一。200 最常见。

1.1 传统接口风格举例

举例：对用户进行操作的相关接口，包括增、删、改、查。

操作	请求方式	URL	成功状态码
查询某个用户	GET/POST	http://127.0.0.1:8080/myweb/user/getUser?id=1 http://127.0.0.1:8080/myweb/User/getByld?id=1 http://127.0.0.1:8080/myweb/getUserByld?id=1	200
查询所有用户	GET/POST	http://127.0.0.1:8080/myweb/user/getUserList http://127.0.0.1:8080/myweb/user/getUsers	200
添加用户	POST	http://127.0.0.1:8080/myweb/user/addUser http://127.0.0.1:8080/myweb/user/saveUser	200
修改用户	POST	http://l127.0.0.1:8080/myweb/user/updateUser http://127.0.0.1:8080/myweb/user/editUser	200
删除用户	GET/POST	http://127.0.0.1:8080/myweb/user/deleteUser?id=1 http://127.0.0.1:8080/myweb/user/delUser?id=1	200

二、RESTful

RESTful是一种网络应用程序的设计风格和开发方式，并不是必须要遵守的标准，只是提供了一组设计原则和约束条件。

REST：即(Representational State Transfer)的缩写。词组的翻译是"表现层状态转化"。如果一个架构符合REST原则，就称它为RESTful架构。

好处： 提供了一套统一遵守的规范，方便团队配合，提高工作效率

2.1 RESTful特点

1、请求方法，与http协议对应。

• GET：查询
• POST：添加
• PUT：修改、更新
• DELETE：删除

2、针对一个资源的操作，URL 唯一。只看URL无法确定具体操作。

3、状态码使用较灵活

4、接口之间传递的数据最常用格式为JSON。

2.2 RESTful接口风格举例

举例：对用户进行操作的相关接口，包括增、删、改、查。

操作	请求方式	URL	成功状态码
查询某个用户	GET	http://127.0.0.1:8080/myweb/uses/1	200
查询所有用户	GET	http://127.0.0.1:8080/myweb/uses	200
添加用户	POST	http://127.0.0.1:8080/myweb/uses/1	201
修改用户	PUT	http://127.0.0.1:8080/myweb/uses/1	201
删除用户	DELETE	http://127.0.0.1:8080/myweb/uses/1	204

2.3 接口API设计规范

特点：面向资源

1、请求API的URL用来定位资源（名词表示)

资源集合
/users        //所有用户
单个资源
/users/1001  //id为1001的用户

2、通过标准HTTP方法对资源CRUD

GET /users			//获取所有用户
GET /users/1001		//获取id为1001的用户
POST /users/1002	//新增id为1002的用户
PUT /users/1001		//修改id为1001的用户
DELETE /users/1001	//删除id为1001的用户

3、利用HTTP状态码返回状态信息

三、接口规范小结