如何用Golang测试REST API接口_Golang REST API测试实践

新闻中心 NEWS CENTER

您当前位置：首页 > 新闻中心 > 网络学院

如何用Golang测试REST API接口_Golang REST API测试实践

2025-11-20

浏览次数：次

返回列表

使用Go的httptest和testing包可高效测试REST API。1. 创建包含getUserHandler和createUserHandler的HTTP服务；2. 用httptest.NewRequest发起请求，httptest.NewRecorder捕获响应；3. 验证状态码、JSON解析及业务逻辑；4. 覆盖正常路径、错误方法（如GET调用POST接口）等场景；5. 封装assertStatusCode等辅助函数减少重复代码。通过标准库即可实现完整测试，关键在于细节处理，如header、状态码和错误校验。

如何用golang测试rest api接口_golang rest api测试实践

测试 REST API 是确保后端服务稳定性和正确性的关键环节。在 Golang 中，利用标准库和一些常用工具，可以高效地对 REST 接口进行单元测试和集成测试。本文介绍如何使用 Go 的 net/http/httptest 和 testing 包来实践 REST API 测试。

搭建简单的 REST API 示例

先创建一个简单的 HTTP 服务作为被测对象：

// main.go
package main

import (
    "encoding/json"
    "net/http"
)

type User struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
}

func getUserHandler(w http.ResponseWriter, r *http.Request) {
    user := User{ID: 1, Name: "Alice"}
    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(user)
}

func main() {
    http.HandleFunc("/user", getUserHandler)
    http.ListenAndServe(":8080", nil)
}

使用 httptest 模拟 HTTP 请求

Go 的 net/http/httptest 包提供了测试 HTTP 服务的工具，比如 httptest.NewRecorder() 可以捕获响应内容。

下面是对上面接口的测试用例：

// main_test.go
package main

import (
    "encoding/json"
    "net/http"
    "net/http/httptest"
    "testing"
)

func TestGetUserHandler(t *testing.T) {
    req := httptest.NewRequest("GET", "/user", nil)
    recorder := httptest.NewRecorder()

    handler := http.HandlerFunc(getUserHandler)
    handler.ServeHTTP(recorder, req)

    if status := recorder.Code; status != http.StatusOK {
        t.Errorf("期望状态码 %d，实际得到 %d", http.StatusOK, status)
    }

    var user User
    err := json.Unmarshal

(recorder.Body.Bytes(), &user)
    if err != nil {
        t.Fatalf("解析 JSON 失败: %v", err)
    }

    if user.ID != 1 {
        t.Errorf("期望 ID 为 1，实际为 %d", user.ID)
    }
    if user.Name != "Alice" {
        t.Errorf("期望 Name 为 Alice，实际为 %s", user.Name)
    }
}

测试不同场景：错误路径与边界情况

真实项目中需覆盖更多情况，例如非法请求方法、参数校验失败等。

示例：添加一个需要 POST 方法的接口：

小云雀

剪映出品的AI视频和图片创作助手

1949 查看详情小云雀

func createUserHandler(w http.ResponseWriter, r *http.Request) {
    if r.Method != "POST" {
        http.Error(w, "仅支持 POST 方法", http.StatusMethodNotAllowed)
        return
    }
    w.WriteHeader(http.StatusCreated)
    w.Write([]byte(`{"message": "用户创建成功"}`))
}

对应的测试：

func TestCreateUserHandler_BadMethod(t *testing.T) {
    req := httptest.NewRequest("GET", "/user", nil)
    recorder := httptest.NewRecorder()

    createUserHandler(recorder, req)

    if recorder.Code != http.StatusMethodNotAllowed {
        t.Errorf("期望状态码 %d，实际 %d", http.StatusMethodNotAllowed, recorder.Code)
    }
}