提高小团队开发效率:Postman 自测与共享实践

94 阅读3分钟

在小团队中,高效的自测和协作是确保项目质量的关键。本文将探讨如何使用 Postman 进行 API 自测,并将重点放在如何将这些自测脚本分享给团队的其他成员。此外,我们还将在 Jeecg 框架下创建一个简单的 Java 项目来演示这个过程。

Postman 自测 vs. 单元测试

Postman 自测的优劣性

优势:

  1. 快速验证:Postman 提供了一种快速验证 API 功能和响应的方式,无需编写复杂的测试代码。
  2. 可视化:可视化界面使测试用例的创建和管理变得非常简单。
  3. 轻松上手:不需要编程知识,团队成员可以迅速学会使用 Postman 进行自测。
  4. 共享与协作:Postman 提供了工作区 (Workspace) 功能,允许团队共享测试用例和环境。

劣势:

  1. 手动测试:Postman 主要用于手动测试,不适用于自动化测试,因此不适合大规模测试和持续集成。
  2. 依赖人力:测试结果依赖于手工操作,容易受到人为因素的影响。
  3. 不适用于逻辑测试:对于需要测试业务逻辑的场景,Postman 可能不够灵活。

如何分享 Postman 脚本给团队

Postman 提供了一种简单的方式来分享自测脚本给团队成员,以提高协作效率。

  1. 使用 Postman Workspace:创建一个 Postman Workspace,将你的自测脚本添加到 Workspace 中。这样,团队的其他成员可以轻松访问并运行这些脚本。Workspace 还支持版本控制,可以跟踪脚本的修改历史。
  2. 共享链接:在 Postman 中,你可以生成一个共享链接,允许其他团队成员直接访问你的测试用例和环境。这个链接是公开的,所以请谨慎分享。
  3. 导出和导入:Postman 允许将测试用例和环境导出为文件,然后分享这些文件给团队成员。他们可以导入这些文件到他们自己的 Postman 中运行。

在 Jeecg 框架下进行 API 自测

现在,让我们演示如何在 Jeecg 框架下创建一个简单的 Java 项目,并使用 Postman 进行 API 自测。

步骤 1: 创建 Jeecg 项目

  1. 使用 Jeecg 框架创建一个新的 Java 项目,或者在现有项目中集成 Jeecg。
  2. 在项目中创建一个学生信息表,包括学生姓名、年龄和成绩等字段。

步骤 2: 生成代码

使用 Jeecg 提供的代码生成器,自动生成学生信息表的实体类、Mapper、Service 等代码。

步骤 3: 编写增删改查接口

在项目中创建一个 RESTful API 控制器,定义学生信息的增加、删除、修改和查询接口。这些接口将使用生成的 Service 类来处理数据操作。

@RestController
@RequestMapping("/students")
public class StudentController {
​
    @Autowired
    private StudentService studentService;
​
    @PostMapping("/")
    public ResponseEntity<Student> addStudent(@RequestBody Student student) {
        Student savedStudent = studentService.save(student);
        return ResponseEntity.ok(savedStudent);
    }
​
    @GetMapping("/{id}")
    public ResponseEntity<Student> getStudent(@PathVariable Long id) {
        Student student = studentService.getById(id);
        return ResponseEntity.ok(student);
    }
​
    @PutMapping("/{id}")
    public ResponseEntity<Student> updateStudent(@PathVariable Long id, @RequestBody Student student) {
        Student updatedStudent = studentService.update(id, student);
        return ResponseEntity.ok(updatedStudent);
    }
​
    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteStudent(@PathVariable Long id) {
        studentService.delete(id);
        return ResponseEntity.noContent().build();
    }
}

步骤 4: 使用 Postman 自测

打开 Postman,依次创建请求集合和请求,用于测试上述 API 接口。编写请求自测用例,验证接口的正确性和可靠性。如创建学生信息集合,再在学生信息集合中,创建添加学生请求,使用POST请求,创建查看学生信息请求,使用GET请求等等。

注意: postman不会自动保存,每次脚本有变更时,都需要使用ctrl+s快捷键,进行变更保存。

步骤5:共享Postman自测脚本

  1. 可使用postman提供的workspace能力进行在线共享
  1. 可使用postman提供的postman脚本导入导出的功能进行离线共享