使用 Go 构建简单的 REST API

Go 是一种很棒的系统编程语言，但它在 Web 上也很出色，尤其是在构建 REST API 时。本指南逐步介绍如何使用 Go 的标准库创建简单的 REST API。我们将构建一个 API 来管理服务器列表，以便我们添加、删除和查看服务器记录。我们还将使用 Go 1.22 新的路由器增强功能进行方法匹配，这使我们能够拥有更清晰的路由和处理程序。

本指南假设您对 Go 有基本的了解并且它已安装在您的计算机上。

设置

为您的项目创建一个新目录并初始化 Go 模块：

mkdir server-api
cd server-api
go mod init server-api

守则

创建一个名为 main.go 的文件。我们将使用 Go 的标准 http 包 - 它拥有基本 API 所需的一切。

package main

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

首先，让我们定义服务器的样子。我们将保持简单 - 只需一个 ID、名称、IP 地址和区域：

type Server struct {
    ID     string `json:"id"`
    Name   string `json:"name"`
    IP     string `json:"ip"`
    Region string `json:"region`
}

我们将使用切片将服务器存储在内存中。在真实的应用程序中，您可能会使用数据库：

var servers = []Server{
    {ID: "srv1", Name: "prod-1", IP: "10.0.1.1", Region: "us-east"},
    {ID: "srv2", Name: "prod-2", IP: "10.0.1.2", Region: "eu-west"},
}

创建路由器

接下来，我们将设置路线。 Go 1.22 引入了一种新的路由语法，使这变得非常简单：

func main() {
    mux := http.NewServeMux()

    mux.HandleFunc("GET /servers", listServers)
    mux.HandleFunc("GET /servers/{id}", showServer)
    mux.HandleFunc("POST /servers", createServer)
    mux.HandleFunc("DELETE /servers/{id}", deleteServer)

    fmt.Println("Server starting on port 8080...")
    log.Fatal(http.ListenAndServe(":8080", mux))
}

处理程序

现在让我们实现每个处理程序。首先，列出所有服务器：

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

通过ID获取单个服务器：

func showServer(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    id := r.PathValue("id")

    for _, server := range servers {
        if server.ID == id {
            json.NewEncoder(w).Encode(server)
            return
        }
    }

    http.Error(w, "Server not found", http.StatusNotFound)
}

创建新服务器：

func createServer(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")

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

    servers = append(servers, server)
    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(server)
}

最后，删除服务器：

func deleteServer(w http.ResponseWriter, r *http.Request) {
    id := r.PathValue("id")

    for i, server := range servers {
        if server.ID == id {
            servers = append(servers[:i], servers[i+1:]...)
            w.WriteHeader(http.StatusNoContent)
            return
        }
    }

    http.Error(w, "Server not found", http.StatusNotFound)
}

使用API

准备好代码后，运行它：

go run main.go

以下是如何使用 cURL 与每个端点交互：

列出所有服务器：

curl localhost:8080/servers

获取特定服务器：

curl localhost:8080/servers/srv1

添加服务器：

curl -X POST localhost:8080/servers   -H "Content-Type: application/json";   -d '{"id":"srv3","name":"prod-3","ip":"10.0.1.3","region":"ap-south"}';

删除服务器：

curl -X DELETE localhost:8080/servers/srv1

接下来是什么？

这是一个基本的 API，但您可以添加很多内容：

• 输入验证
• 正确的错误处理
• 使用 PostgreSQL 等数据库保存服务器
• 身份验证
• 请求记录
• 单元测试

标准库具有令人惊讶的构建 API 的能力。虽然有更多功能齐全的框架可用，但从标准库开始可以帮助您了解基础知识，而不会在幕后发生任何魔法。

以上是使用 Go 构建简单的 REST API的详细内容。更多信息请关注PHP中文网其他相关文章！