Golang实现REST接口教程详解

来到golang学习网的大家，相信都是编程学习爱好者，希望在这里学习Golang相关编程知识。下面本篇文章就来带大家聊聊《Golang用net/http实现REST接口详解》，介绍一下，希望对大家的知识积累有所帮助，助力实战开发！

答案：使用Go标准库net/http可高效构建REST接口，通过HTTP方法对应资源操作，结合路由注册、JSON处理、状态码设置及中间件提升可维护性。示例展示了用户服务的增删改查，支持GET、POST等方法，返回标准JSON格式，并推荐添加日志、统一错误处理和响应结构，适用于轻量级API或微服务场景。

理解REST与HTTP方法对应关系

REST（Representational State Transfer）是一种设计风格，强调资源的操作通过标准 HTTP 方法完成。常见操作与 HTTP 方法对应如下：

• GET：获取资源
• POST：创建资源
• PUT：更新资源（全量）
• PATCH：部分更新资源
• DELETE：删除资源

• GET /users → 获取用户列表
• POST /users → 创建新用户
• GET /users/1 → 获取 ID 为 1 的用户
• PUT /users/1 → 更新该用户信息
• DELETE /users/1 → 删除该用户

使用net/http注册路由并处理请求

net/http 提供了 DefaultServeMux 作为默认的多路复用器，可通过 http.HandleFunc 注册路径和处理器函数。

package main

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

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

var users = []User{
    {ID: 1, Name: "Alice", Email: "alice@example.com"},
}

func getUsers(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(users)
}

func createUser(w http.ResponseWriter, r *http.Request) {
    if r.Method != "POST" {
        http.Error(w, "只支持 POST 请求", http.StatusMethodNotAllowed)
        return
    }

    var user User
    if err := json.NewDecoder(r.Body).Decode(&user); err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    user.ID = len(users) + 1
    users = append(users, user)

    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(user)
}

func getUserByID(w http.ResponseWriter, r *http.Request) {
    id := r.URL.Path[len("/users/"):]

    for _, u := range users {
        if fmt.Sprint(u.ID) == id {
            w.Header().Set("Content-Type", "application/json")
            json.NewEncoder(w).Encode(u)
            return
        }
    }

    http.Error(w, "用户不存在", http.StatusNotFound)
}

func main() {
    http.HandleFunc("/users", func(w http.ResponseWriter, r *http.Request) {
        if r.Method == "GET" {
            getUsers(w, r)
        } else if r.Method == "POST" {
            createUser(w, r)
        } else {
            http.Error(w, "不支持的方法", http.StatusMethodNotAllowed)
        }
    })

    http.HandleFunc("/users/", getUserByID)

    log.Println("服务器启动在 :8080")
    log.Fatal(http.ListenAndServe(":8080", nil))
}

提升可维护性：自定义路由与中间件

随着接口增多，使用 DefaultServeMux 可能不够灵活。可以手动创建 ServeMux 或封装更清晰的结构。

• 按资源分组路由
• 统一错误处理格式
• 添加日志、CORS、认证等中间件

func loggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        log.Printf("%s %s %s", r.RemoteAddr, r.Method, r.URL)
        next(w, r)
    }
}

http.HandleFunc("/users", loggingMiddleware(getUsers))

处理JSON与状态码的最佳实践

正确设置响应头、状态码和 JSON 输出是构建专业 API 的关键。

• 始终设置 Content-Type: application/json
• 创建资源返回 StatusCreated (201)
• 成功但无内容返回 StatusNoContent (204)
• 参数错误使用 StatusBadRequest (400)
• 资源未找到返回 StatusNotFound (404)
• 方法不支持返回 StatusMethodNotAllowed (405)

type Response struct {
    Success bool        `json:"success"`
    Data    interface{} `json:"data,omitempty"`
    Message string      `json:"message,omitempty"`
}

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于Golang的相关知识，也可关注golang学习网公众号。