0

0

Go语言如何实现简单API服务_REST接口基础实现

P粉602998670

P粉602998670

发布时间:2026-01-14 08:54:10

|

870人浏览过

|

来源于php中文网

原创

用 net/http 启最简 REST 服务需:1. 用 http.HandleFunc 绑定资源路径(如 /users);2. 在处理函数中按 req.Method 区分 HTTP 方法;3. 显式设置状态码并用 json.NewEncoder 返回标准 JSON 响应。

go语言如何实现简单api服务_rest接口基础实现

用 net/http 启一个最简 REST 服务

Go 原生 net/http 足够跑出符合 REST 风格的 API,不需要框架也能清晰表达资源语义。关键不是“能不能”,而是路由怎么映射、请求怎么解析、响应怎么组织。

核心是:用 http.HandleFunc 绑定路径和处理函数,再在函数里根据 req.Method 区分 GET/POST/PUT/DELETE;不要靠多个独立端口或 query 参数模拟动作。

  • 所有路径应以资源为中心,比如 /users/users/123
  • 避免写成 /getUsers/api?action=delete
  • 处理函数必须显式检查 req.Method,否则容易忽略方法误用(比如用 GET 接收 JSON body)

解析 JSON 请求体并校验字段

Go 的 json.Unmarshal 默认对缺失字段静默容忍,直接解到 struct 可能导致空值被当成合法输入。REST 接口要求明确失败反馈,不能靠客户端猜。

常见错误是只做 err != nil 判断,却没检查结构体字段是否为空或越界。例如接收用户创建请求时,NameEmail 应为必填,但默认 struct 解码不会报错。

立即学习go语言免费学习笔记(深入)”;

人民网AIGC-X
人民网AIGC-X

国内科研机构联合推出的AI生成内容检测工具

下载
  • 给字段加 json:"name,omitempty" 不解决必填问题,要用自定义校验逻辑
  • 推荐先用 json.RawMessage 做预读,再按需解码——避免 panic 或静默丢数据
  • POST /users 这类创建接口,返回 400 Bad Request 并附具体错误字段比返回 500 更合理

返回标准 JSON 响应与状态码

REST 接口的响应不是“有 JSON 就行”,而要匹配 HTTP 状态码语义。比如 GET /users/999 找不到资源,该返回 404 Not Found,而不是 200 OK 加个 {"error": "not found"}

Go 默认 http.ResponseWriter 的状态码是 200,不显式设置就永远 200。很多初学者漏掉这步,导致前端无法靠 status 判断流程分支。

  • w.WriteHeader(http.StatusNotFound) 显式设状态码,再写 body
  • 统一响应结构推荐:包含 code(业务码)、messagedata(可选),但不要和 HTTP status 冗余
  • 别用 fmt.Fprintf(w, ...) 拼 JSON 字符串,用 json.NewEncoder(w).Encode(...) 防止格式错误和 XSS 风险
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 = map[int]User{
	1: {ID: 1, Name: "Alice", Email: "alice@example.com"},
}

func userHandler(w http.ResponseWriter, r *http.Request) {
	switch r.Method {
	case "GET":
		id := 1 // 简化示例,实际应从 URL path 提取
		if u, ok := users[id]; ok {
			w.Header().Set("Content-Type", "application/json")
			json.NewEncoder(w).Encode(u)
		} else {
			w.WriteHeader(http.StatusNotFound)
			json.NewEncoder(w).Encode(map[string]string{"error": "user not found"})
		}
	case "POST":
		var u User
		if err := json.NewDecoder(r.Body).Decode(&u); err != nil {
			w.WriteHeader(http.StatusBadRequest)
			json.NewEncoder(w).Encode(map[string]string{"error": "invalid JSON"})
			return
		}
		if u.Name == "" || u.Email == "" {
			w.WriteHeader(http.StatusBadRequest)
			json.NewEncoder(w).Encode(map[string]string{"error": "name and email required"})
			return
		}
		users[u.ID] = u
		w.WriteHeader(http.StatusCreated)
		json.NewEncoder(w).Encode(u)
	default:
		w.WriteHeader(http.StatusMethodNotAllowed)
		json.NewEncoder(w).Encode(map[string]string{"error": "method not allowed"})
	}
}

func main() {
	http.HandleFunc("/users", userHandler)
	log.Println("Server starting on :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

真正难的不是写完这个例子,而是后续加中间件(日志、鉴权)、处理并发读写 map、支持路径参数(如 /users/{id})、做 graceful shutdown —— 这些不写在基础例子里,但上线第一天就会撞上。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

177

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

212

2025.12.18

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

411

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

532

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

187

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

271

2023.10.25

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号