Postman：测试REST API的CRUD操作 | 作者：Austėja Mituzaitė

使用Postman测试REST API的CRUD操作

在应用程序编程接口）在实现软件应用程序之间的通信和数据交换方面扮演了重要角色。API通常基于不同的架构风格构建，这些风格决定了信息的结构化、传输和访问方式。常见的架构风格包括：

• 代表性状态转移（REST）
• 简单对象访问协议（SOAP）

其中，REST因其简单性而广受欢迎。它通过URL定义路由，并使用HTTP协议执行操作，主要支持基于文本的数据。相比需要用XML封装路由的SOAP协议，REST的简单性在某些场景下更具优势。

什么是CRUD操作？

CRUD是指API的四种基本操作：

• C – 创建（Create）：通过HTTP POST方法向API添加新资源。
• R – 读取（Read）：通过HTTP GET方法从API检索数据。
• U – 更新（Update）：通过HTTP PUT或PATCH方法修改API中的现有资源。
• D – 删除（Delete）：通过HTTP DELETE方法从API中删除资源。

使用dummyJSON API进行CRUD操作

为了演示CRUD操作，我们将使用一个模拟API——dummyJSON。该API提供了多个部分（如用户、帖子、评论等），本文将聚焦于其产品部分。您可以在官方文档中查看完整的API说明。

1. GET请求

GET请求用于从API中检索数据。以下是一些常见的GET操作：

• 获取所有产品
• 获取单个产品
• 搜索产品
• 获取所有产品类别
• 获取某一类别的产品

2. POST请求

POST请求用于向API添加新资源。例如，向产品列表中添加一个新产品。

3. PUT请求

PUT请求用于更新现有资源。它可以完全替换资源的内容，也可以通过PATCH方法部分更新资源。

4. DELETE请求

DELETE请求用于从API中删除指定资源。

在Postman中设置环境

Postman是一款强大的HTTP客户端工具，开发人员和测试人员可以使用它来简化API的开发和测试过程。以下是设置Postman的步骤：

1. 安装Postman

您可以选择以下任意一种方式安装Postman：

• 使用Postman网页版（需要注册/登录）。
• 下载桌面应用程序。
• 安装VS Code扩展。

2. 创建工作区和环境

1. 点击Postman顶部菜单中的“工作区”选项，选择“创建工作区”。
2. 在左侧菜单中找到“环境”，为项目创建一个新环境。
3. 在环境中添加一个名为BASE URL的变量，并将其值设置为https://dummyjson.com/products。这样可以在请求中直接引用该变量，而无需每次手动输入URL。

3. 创建请求集合

1. 导航到“Collections”，创建一个新的集合，用于存储HTTP请求。
2. 在集合中创建两个文件夹：一个用于正常请求（快乐路径），另一个用于错误处理。

测试CRUD操作

1. GET请求

• 获取所有产品：发送GET请求到{{BASE URL}}。
• 获取单个产品：在URL中添加产品ID，例如BASE URL/1。
• 搜索产品：在URL中添加搜索关键字，例如BASE URL/search?q=keyword。
• 获取所有类别：发送GET请求到BASE URL/categories。
• 获取某类别的产品：在URL中添加类别名称，例如BASE URL/category/category_name。

2. POST请求

• 添加新产品：
  1. 将URL设置为{{BASE URL}}/add。
  2. 在请求头中添加Content-Type: application/json。
  3. 在请求体中以JSON格式提供新产品的数据，例如：

     {
     "title": "新产品",
     "price": 100
     }

3. PUT请求

• 更新产品：
  1. 将URL设置为{{BASE URL}}/1（1为产品ID）。
  2. 在请求体中提供更新的数据，例如：

     {
     "title": "更新后的产品名称"
     }

4. DELETE请求

• 删除产品：
  1. 将URL设置为{{BASE URL}}/1（1为产品ID）。
  2. 发送DELETE请求。

测试错误处理

为了验证API的错误处理机制，我们可以故意发送错误请求。例如：

• GET请求：
  • 请求不存在的产品ID，例如BASE URL/101（ID超出范围）。
  • 搜索不存在的关键字，例如BASE URL/search?q=non_existent。
• POST请求：
  • 向错误的端点发送请求，例如BASE URL/wrong_endpoint。
• PUT请求：
  • 更新不存在的产品ID，例如{{BASE URL}}/200。
• DELETE请求：
  • 删除不存在的产品ID，例如{{BASE URL}}/200。

响应状态码

在测试过程中，我们会关注以下状态码：

• 100-199：信息性响应
• 200-299：成功响应
• 300-399：重定向响应
• 400-499：客户端错误
• 500-599：服务器错误

对于正常请求，我们期望返回200状态码；对于错误请求，我们期望返回404状态码。

总结

通过本文的演示，我们成功使用PostmanCRUD操作，并验证了API的错误处理机制。Postman提供了直观的界面和强大的功能，使得API测试变得更加高效和便捷。

如果您想了解更多关于Postman的使用，请参考Postman官方文档。

测试愉快！

原文链接: https://medium.com/@austejamitz/postman-test-crud-operations-of-a-rest-api-1716bca21a62