首页 > Golang > Go教程

GolangRESTfulAPI开发教程详解

时间：2025-10-25 21:06:59 329浏览收藏

想快速上手Golang开发？构建一个RESTful API服务是个不错的选择！本文将带你通过一个简易的“待办事项”（Todo）API项目，完成Golang入门级RESTful开发的完整流程。我们将使用Golang标准库 `net/http` 搭配轻量级路由库 `gorilla/mux`，实现Todo的增删改查接口。文章将详细讲解如何定义Todo结构体，使用内存存储并配合同步锁保障并发安全，通过 `mux.Router` 配置路由，以及如何启动HTTP服务并进行API测试。通过本文，你将掌握Golang基础语法、标准库使用、路由控制和数据解析，为后续学习数据库操作和中间件打下坚实基础。

答案：通过构建Todo RESTful API掌握Golang基础开发。使用net/http和gorilla/mux实现增删改查接口，定义Todo结构体与内存存储，配合同步锁保障并发安全，通过mux.Router配置路由，main函数启动服务，完成API测试后可扩展数据库与中间件。

Golang入门项目中RESTful API开发实践

想快速上手Golang开发，写一个RESTful API服务是个不错的选择。它能帮你掌握基础语法、标准库使用、路由控制、数据解析和简单数据库操作。下面通过一个简易的“待办事项”（Todo）API项目，带你走完Golang入门级RESTful开发的完整流程。

项目目标与技术栈

我们要实现一个支持增删改查的Todo API，包含以下接口：

GET /todos — 获取所有待办事项
GET /todos/{id} — 获取指定ID的待办事项
POST /todos — 创建新的待办事项
PUT /todos/{id} — 更新指定ID的待办事项
DELETE /todos/{id} — 删除指定ID的待办事项

技术选型使用Golang标准库为主，搭配轻量级路由库 gorilla/mux，不引入复杂框架，便于理解底层逻辑。

初始化项目与依赖管理

创建项目目录并初始化模块：

mkdir todo-api
cd todo-api
go mod init todo-api

引入 gorilla/mux 路由库：

go get github.com/gorilla/mux

此时项目会生成 go.mod 文件，用于管理依赖。

定义数据结构与存储逻辑

创建一个 Todo 结构体，用于表示待办事项：

type Todo struct {
  ID     int    `json:"id"`
  Title string `json:"title"`
  Done   bool  `json:"done"`
}

使用切片模拟内存存储，并用互斥锁保护并发访问：

var (
  todos []Todo
  mu    sync.Mutex
  nextID = 1
)

这种做法适合学习，实际项目应替换为数据库（如SQLite、PostgreSQL）。

实现HTTP处理函数

每个API接口对应一个处理函数。以获取全部待办事项为例：

func getTodos(w http.ResponseWriter, r *http.Request) {
  mu.Lock()
  defer mu.Unlock()
  w.Header().Set("Content-Type", "application/json")
  json.NewEncoder(w).Encode(todos)
}

创建新待办事项的POST接口需要解析JSON请求体：

func createTodo(w http.ResponseWriter, r *http.Request) {
  var todo Todo
  if err := json.NewDecoder(r.Body).Decode(&todo); err != nil {
    http.Error(w, "无效的JSON", http.StatusBadRequest)
    return
  }
  todo.ID = nextID
  nextID++
  mu.Lock()
  todos = append(todos, todo)
  mu.Unlock()
  w.Header().Set("Content-Type", "application/json")
  w.WriteHeader(http.StatusCreated)
  json.NewEncoder(w).Encode(todo)
}

其他接口（获取单个、更新、删除）逻辑类似，注意处理路径参数和边界情况。

配置路由与启动服务

使用 gorilla/mux 设置路由：

r := mux.NewRouter()
r.HandleFunc("/todos", getTodos).Methods("GET")
r.HandleFunc("/todos", createTodo).Methods("POST")
r.HandleFunc("/todos/{id}", getTodo).Methods("GET")
r.HandleFunc("/todos/{id}", updateTodo).Methods("PUT")
r.HandleFunc("/todos/{id}", deleteTodo).Methods("DELETE")

在 main 函数中启动HTTP服务：

func main() {
fmt.Println("服务器启动在 :8080")
log.Fatal(http.ListenAndServe(":8080", r))
}

运行 go run main.go 即可启动服务。

测试API接口

使用 curl 或 Postman 测试接口。例如创建一个待办事项：

curl -X POST http://localhost:8080/todos \
-H "Content-Type: application/json" \
-d '{"title":"学习Golang","done":false}'

然后访问 GET /todos 查看列表，验证数据是否正确返回。

基本上就这些。这个小项目涵盖了Golang Web开发的核心要素：结构体定义、JSON编解码、HTTP服务、路由控制和基础并发安全。后续可扩展数据库支持、中间件（日志、认证）、错误统一处理等，逐步进阶。不复杂但容易忽略细节，动手写一遍印象更深。

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

golang HTTP RESTfulAPI TODO gorilla/mux