如何在 Golang 中测试 Web API？

在 Golang 中测试 Web API 至关重要，以确保应用程序以预期的方式运行。本文将介绍使用[ httptest 包](https://pkg.go.dev/net/http/httptest)进行单元测试的分步指南，并提供一个实用的示例。

1. 导入 httptest 包

使用 import 语句导入 httptest 包：

立即学习“go语言免费学习笔记（深入）”；

import (
  "bytes"
  "net/http"
  "net/http/httptest"
  "testing"
)

2. 创建一个 HTTP 测试句柄

使用 httptest.NewRecorder 函数创建一个 HTTP 测试句柄，该句柄将记录请求的响应。

func TestHandler(t *testing.T) {
  rr := httptest.NewRecorder()
  req, err := http.NewRequest("GET", "/api/v1/users", nil)
  if err != nil {
    t.Fatal(err)
  }
  
  // 这里调用要测试的实际函数的代码
}

3. 验证响应

使用 rr.Code 和 rr.Body 等方法验证 HTTP 测试句柄中记录的响应：

if rr.Code != http.StatusOK {
  t.Errorf("状态代码错误：获取 %d，期望 %d", rr.Code, http.StatusOK)
}

4. 实战案例

以下是一个展示如何使用 httptest 包测试 Web API 端点的完整实战案例：

func TestGetUser(t *testing.T) {
  user := User{ID: 1, Name: "John"}
  jsonBytes, err := json.Marshal(user)
  if err != nil {
    t.Fatal(err)
  }
  
  rr := httptest.NewRecorder()
  req, err := http.NewRequest("GET", "/api/v1/users/1", bytes.NewReader(jsonBytes))
  if err != nil {
    t.Fatal(err)
  }
  getUserHandler(rr, req)
  
  if rr.Code != http.StatusOK {
    t.Errorf("状态代码错误：获取 %d，期望 %d", rr.Code, http.StatusOK)
  }
  
  var returnedUser User
  err = json.Unmarshal(rr.Body.Bytes(), &returnedUser)
  if err != nil {
    t.Fatal(err)
  }
  
  if returnedUser != user {
    t.Errorf("返回的用户不正确：获取 %v，期望 %v", returnedUser, user)
  }
}