Restful接口开发测试指南

1、 什么是 Restful

1.1  定义

表征状态转移，一种新的通讯架构。一般用于 HTTP 。

https://www.runoob.com/w3cnote/restful-architecture.html

1.2  .net 下的 Restful API

.net 下的 Restful API 采用 WebAPI 框架， WebAPI 和 SignalR 都是事先服务的框架，但是 SignalR 面向实时性服务。而 WebAPI 用于构建常规的 Restful API 。

l  支持基于 Http verb (GET, POST, PUT, DELETE) 的 CRUD (create, retrieve, update, delete) 操作 ， 通过不同的 http 动作表达不同的含义，这样就不需要暴露多个 API 来支持这些基本操作。

l  请求的回复通过 Http Status Code 表达不同含义，客户端可以通过 Accept header 来与服务器协商格式，例如服务器返回 JSON 格式还是 XML 格式 ； 请求的回复格式支持 JSON ， XML ，并且可以扩展添加其他格式。

l  原生支持 OData ：开放数据协议（ Open Data Protocol ，缩写 OData ）是一种描述如何创建和访问 Restful 服务的 OASIS 标准。

l  支持 Self-host 或者 IIS host ； 支持大多数 MVC 功能，例如 Routing/Controller/Action Result/Filter/Model Builder/IOC Container/Dependency Injection 。

1.3  什么时候需要 WebAPI

以下情况需要使用 WebAPI ：

l  Web Service ， 但不需要 SOAP 。

l  在已有的 Windows Communication Foundation 框架 上建立 non-soap-based http 服务 。

l  只想发布一些简单的 Http 服务，不想使用相对复杂的 WCF 配置 。

l  发布的服务可能会被带宽受限的设备访问 。

l  不需要复杂的 MVC 框架， Web API 与 MVC 的区别 如下：

n  MVC 主要用来构建网站，既关心数据也关心页面展示，而 Web API 只关注数据

n  Web API 支持格式协商，客户端可以通过 Accept header 通知服务器期望的格式

n  Web API 支持 Self Host ， MVC 目前不支持

n  Web API 通过不同的 http verb 表达不同的动作 (CRUD) ， MVC 则通过 Action 名字表达动作

n  Web API 内建于 ASP.NET System.Web.Http 命名空间下， MVC 位于 System.Web.Mvc 命名空间下，因此 model binding/filter/routing 等功能有所不同

1.4  WebAPI 实现的 Restful API 路由机制

参考： https://www.cnblogs.com/landeanfen/p/5501490.html

2、 SoapUI 工具模拟 Restful API 服务器端

2.1 下载

官网下载链接：

https://www.soapui.org/downloads/thank-you-for-downloading-soapui.html

会自动下载，否则重新输入：

https://s3.amazonaws.com/downloads.eviware/soapuios/5.5.0/SoapUI-x32-5.5.0.exe

2.2 安装

直接按提示安装即可，运行界面：

2.3 创建 Rest project

点击左侧 “Projects”，如下：

运行 New Rest Project ，如下：

录入： http://localhost:8080/api/test 之后，点 OK ，出来如下界面：

增加一个 Get 参数 id ，如下：

到此完成了 test 的接口定义。

2.3 创建 Mock 服务

右键点击左侧的 “ http://localhost:8080 ” , 弹出如下窗口：

执行 “ Generate REST Mock service ”，则显示：

修改名字为 Mock 服务，点 OK ，则显示：

注意运行端口已经被改为 8089.

到此，成功建立模拟 Restful服务器。

3、 RESTClient 工具模拟 Restful API 前端

3.1 下载

官网链接： https://www.wiztools.org/index.html

编译后的下载链接： https://github.com/wiztools/rest-client/releases

下载文件： restclient-ui-3.7.1.zip

3.2 安装

解压到目录： D:\restclient-ui-3.7.1

双击 bin\restclient-ui.bat 执行：

3.3 创建

输入刚才在 SoapUI 中创建的 Mock 服务地址和参数，如下

点击右侧的按钮执行：

报 404 错误，查找原因：

查看 SoapUI 中有两个 Mock 服务启动：

停止一个，后再试：

返回为空。

查看 SoapUI 的 Mock 服务的 response 1 ：

是空的，增加一段 json 数据：

重新启动 Mock 服务。

然后返回 RESTClient ：

大功告成！！！