Go语言实现RESTful API

在Go语言中实现RESTful API可以利用标准库net/http提供的功能，它允许你轻松地创建和处理HTTP请求。以下是一个基本的示例，展示了如何使用Go来创建一个简单的RESTful API，包括CRUD（创建、读取、更新、删除）操作：

1. 导入所需的包

首先，我们需要导入net/http包以及任何其他需要的包。

package main

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

2. 定义资源数据结构

接下来，我们定义要操作的资源的数据结构。在这个例子中，我们将使用一个简单的User结构体。

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

3. 初始化资源集合

为了演示API的功能，我们可以初始化一个用户列表，用作临时存储。

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

4. 创建处理器函数

现在我们可以开始编写处理器函数，它们将响应客户端的HTTP请求。每个函数负责一个特定的URL路径，并且根据HTTP方法执行相应的操作。

• GET /users：列出所有用户。

• POST /users：创建新用户。

• GET /users/{id}：获取单个用户。

• PUT /users/{id}：更新用户信息。

• DELETE /users/{id}：删除用户。

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) {
	var user User
	err := json.NewDecoder(r.Body).Decode(&user)
	if err != nil {
		http.Error(w, err.Error(), http.StatusBadRequest)
		return
	}
	user.ID = len(users) + 1
	users = append(users, user)
	w.WriteHeader(http.StatusCreated)
	json.NewEncoder(w).Encode(user)
}

func getUser(w http.ResponseWriter, r *http.Request) {
	params := mux.Vars(r)
	for _, item := range users {
		if strconv.Itoa(item.ID) == params["id"] {
			json.NewEncoder(w).Encode(item)
			return
		}
	}
	http.NotFound(w, r)
}

func updateUser(w http.ResponseWriter, r *http.Request) {
	params := mux.Vars(r)
	for index, item := range users {
		if strconv.Itoa(item.ID) == params["id"] {
			var user User
			err := json.NewDecoder(r.Body).Decode(&user)
			if err != nil {
				http.Error(w, err.Error(), http.StatusBadRequest)
				return
			}
			item.Name = user.Name
			item.Email = user.Email
			users[index] = item
			json.NewEncoder(w).Encode(item)
			return
		}
	}
	http.NotFound(w, r)
}

func deleteUser(w http.ResponseWriter, r *http.Request) {
	params := mux.Vars(r)
	for index, item := range users {
		if strconv.Itoa(item.ID) == params["id"] {
			users = append(users[:index], users[index+1:]...)
			break
		}
	}
	w.WriteHeader(http.StatusOK)
}

5. 注册处理器函数

现在我们有了处理器函数，但还需要将它们与对应的URL路径关联起来。为此，我们可以使用http.HandleFunc()或第三方路由器库如gorilla/mux。

func main() {
	r := mux.NewRouter()
	r.HandleFunc("/users", getUsers).Methods("GET")
	r.HandleFunc("/users", createUser).Methods("POST")
	r.HandleFunc("/users/{id}", getUser).Methods("GET")
	r.HandleFunc("/users/{id}", updateUser).Methods("PUT")
	r.HandleFunc("/users/{id}", deleteUser).Methods("DELETE")

	log.Fatal(http.ListenAndServe(":8080", r))
}

6. 运行程序并测试API

编译并运行你的Go程序。你可以使用像curl这样的工具或者浏览器来测试API。例如，列出所有用户：

sh$ curl -i http://localhost:8080/users

请注意，这个示例假设你已经安装了gorilla/mux库，并且已经在代码顶部添加了必要的导入语句。

结论

这就是一个简单的Go RESTful API的基本结构。实际上，你可能需要进行一些额外的工作，比如错误处理、输入验证、安全性等。然而，这个例子为你提供了一个起点，让你了解如何使用Go构建一个RESTful API。

原文链接: https://www.yukx.com/golang/article/details/2436.html 优科学习网Go语言实现RESTful API