RESTful-API开发与测试.ppt

1、RESTful API开发与测试,平台功能模块简介,一、RESTful 简述二、RESTful API编写规范三、RESTful API在SSM中的实现四、RESTful API测试,一、RESTful简述,REST（英文：Representational State Transfer，简称REST）描述了一个架构样式的网络系统，比如 web 应用程序。REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful；Web 应用程序最重要的 REST 原则是，客户端和服务器之间的交互在请求之间是无状态的；在服务器端，应用程序状态和功能可以分为各种资源。,二、

2、 RESTful API编写规范,1、协议API与用户的通信协议，总是使用HTTPs协议。2、域名应该尽量将API部署在专用域名之下：https:/如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下：https:/ RESTful API编写规范,3、版本（Versioning）应该将API的版本号放入URL：https:/ 另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。4、路径（Endpoint）路径又称终点（endpoint），表示API的具体网址。在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所

3、用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的集合（collection），所以API中的名词也应该使用复数。,二、 RESTful API编写规范,4、路径（Endpoint）举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样：https:/ https:/ https:/ RESTful API编写规范,5、HTTP动词对于资源的具体操作类型，由HTTP动词表示。常用的HTTP动词有下面五个（括号里是对应的SQL命令）：GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器

4、新建一个资源。 PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。 PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。 DELETE（DELETE）：从服务器删除资源。,二、 RESTful API编写规范,5、HTTP动词还有两个不常用的HTTP动词：HEAD：获取资源的元数据。 OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。,二、 RESTful API编写规范,5、HTTP动词下面是一些例子：GET /zoos：列出所有动物园 POST /zoos：新建一个动物园 GET /zoos/ID：获取某个指定动物园的信息 PUT /z

5、oos/ID：更新某个指定动物园的信息（提供动物园的全部信息） PATCH /zoos/ID：更新某指定动物园的信息（提供动物园的部分信息） DELETE /zoos/ID：删除某个动物园 GET /zoos/ID/animals：列出某个指定动物园的所有动物 DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物,二、 RESTful API编写规范,6、过滤信息（Filtering）如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。下面是一些常见的参数：?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的

6、开始位置。 ?page=2&per_page=100：指定第几页，以及每页的记录数。 ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。 ?animal_type_id=1：指定筛选条件 参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的,二、 RESTful API编写规范,7、状态码（Status Codes）200 OK - GET：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。 201 CREATED

7、 - POST/PUT/PATCH：用户新建或修改数据成功。 202 Accepted - *：表示一个请求已经进入后台排队（异步任务） 204 NO CONTENT - DELETE：用户删除数据成功。 400 INVALID REQUEST - POST/PUT/PATCH：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。 401 Unauthorized - *：表示用户没有权限（令牌、用户名、密码错误）。 403 Forbidden - * 表示用户得到授权（与401错误相对），但是访问是被禁止的。 404 NOT FOUND - *：用户发出的请求针对的是不

8、存在的记录，服务器没有进行操作，该操作是幂等的。 406 Not Acceptable - GET：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。 410 Gone -GET：用户请求的资源被永久删除，且不会再得到的。 422 Unprocesable entity - POST/PUT/PATCH 当创建一个对象时，发生一个验证错误。 500 INTERNAL SERVER ERROR - *：服务器发生错误，用户将无法判断发出的请求是否成功。,二、 RESTful API编写规范,8、错误处理（Error handling）如果状态码是4xx，就应该向用户返回出错信

9、息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可： error: Invalid API key ,二、 RESTful API编写规范,9、返回结果针对不同操作，服务器向用户返回的结果应该符合以下规范：GET /collection：返回资源对象的列表（数组） GET /collection/resource：返回单个资源对象 POST /collection：返回新生成的资源对象 PUT /collection/resource：返回完整的资源对象 PATCH /collection/resource：返回完整的资源对象 DELETE /collection/resou

10、rce：返回一个空文档,二、 RESTful API编写规范,10、Hypermedia APIRESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。比如，当用户向的根目录发出请求，会得到这样一个文档：link: rel: collection https:/ href: https:/ title: List of zoos, type: application/vnd.yourformat+json ,二、 RESTful API编写规范,10、Hypermedia API上面代码表示，文档中有一个link属

11、性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。,三、RESTful API SSM实现,1、GET类型API实现2、DELETE类型API实现3、POST类型API实现4、PUT类型API实现以上API均采用JSON格式数据传输,三、RESTful API SSM实现,1、GET类型API实现,三、RESTful API SSM实现,2、DELETE类型API实现,三、RESTful API SSM实现,3、POST类型API实现,三、RESTful API SSM实现,4、PUT类型API实现,四、RESTful API 测试,1、编码测试2、工具测试,四、RESTful API 测试,1、编码测试a、java原生API,四、RESTful API 测试,1、编码测试b、httpClient,四、RESTful API 测试,1、编码测试c、python,四、RESTful API 测试,1、编码测试d、jQuery,四、RESTful API 测试,2、工具测试a、Fiddler,四、RESTful API 测试,2、工具测试b、Jmeter,