当前位置:首页 > 文章列表 > Golang > Go教程 > Golang搭建简单JSON API教程

Golang搭建简单JSON API教程

2026-05-25 18:02:27 0浏览 收藏
本文手把手教你用Golang标准库(net/http和encoding/json)零依赖搭建轻量、可靠的JSON API服务:从定义带json标签的User结构体、设置Content-Type响应头,到注册/user和/health路由并实现GET数据返回与可选POST用户创建,再到启动8080端口服务及用curl或浏览器快速验证——全程简洁清晰,无需第三方框架,既适合初学者入门API开发,也具备生产级扩展潜力。

Golang如何实现简单的JSON API服务

用Golang实现一个简单的JSON API服务并不复杂,核心是使用标准库中的 net/httpencoding/json。下面是一个完整的示例,展示如何创建一个返回JSON数据的HTTP服务。

1. 定义数据结构和路由处理函数

先定义一个结构体来表示要返回的数据,并编写处理请求的函数:

package main

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

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

func getUser(w http.ResponseWriter, r *http.Request) { user := User{ ID: 1, Name: "Alice", Email: "alice@example.com", }

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

}

说明:
- 使用 json: 标签控制字段在JSON中的名称。
- 设置响应头为 application/json,确保客户端正确解析。
- 使用 json.NewEncoder(w).Encode() 直接将结构体写入响应流。

2. 启动HTTP服务器并注册路由

在 main 函数中设置路由并启动服务:

func main() {
    http.HandleFunc("/user", getUser)
http.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK)
    w.Write([]byte("OK"))
})

println("Server is running on :8080")
http.ListenAndServe(":8080", nil)

}

说明:
- 使用 http.HandleFunc 注册路径与处理函数的映射。
- 添加一个简单的健康检查接口 /health,用于测试服务是否正常。
- 调用 ListenAndServe 启动服务器,默认监听本地8080端口。

3. 测试API

运行程序后,打开终端或浏览器测试:

  • 访问 http://localhost:8080/user,会返回JSON:
{"id":1,"name":"Alice","email":"alice@example.com"}
  • 访问 http://localhost:8080/health,返回纯文本 OK。

也可以用 curl 测试:

curl -s http://localhost:8080/user | python -m json.tool

4. 处理POST请求(可选扩展)

如果需要接收JSON输入,可以这样处理:

func createUser(w http.ResponseWriter, r *http.Request) {
    if r.Method != "POST" {
        http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
        return
    }
var user User
err := json.NewDecoder(r.Body).Decode(&user)
if err != nil {
    http.Error(w, "Invalid JSON", http.StatusBadRequest)
    return
}

// 模拟保存成功,返回带ID的结果
user.ID = 100
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusCreated)
json.NewEncoder(w).Encode(user)

}

然后在 main 中注册:
http.HandleFunc("/user", createUser)(注意区分GET/POST)

基本上就这些。Golang的标准库足够应付大多数简单API场景,无需引入框架也能快速搭建稳定服务。关键点是设置正确的Content-Type、使用结构体标签、合理处理错误。后续可扩展日志、中间件、路由分组等功能。

好了,本文到此结束,带大家了解了《Golang搭建简单JSON API教程》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多Golang知识!

Python TensorFlow 2.x CPU内存占用高?限制线程数解决Python TensorFlow 2.x CPU内存占用高?限制线程数解决
上一篇
Python TensorFlow 2.x CPU内存占用高?限制线程数解决
元旦广州车票紧张吗?
下一篇
元旦广州车票紧张吗?
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • 剧云 - 免费 AI 智能中文剧本创作平台
    剧云
    剧云是专业中文剧本创作平台,安全稳定运行十余年,集成AI编剧、剧本医生审核、人物小传、剧情关系图、大纲编写、多人协作、Word导入导出、版权管控功能,数据安全防护,轻松高效创作剧本。
    96次使用
  • 万象有声 - AI 一站式有声内容创作平台
    万象有声
    万象有声,一个专为有声创作者打造的新一代智能有声内容创作平台。平台提供专业的智能拆章、智能画本编辑、AI配音、AI生成音效、后期制作、智能对轨、智能审听等有声创作全流程工具,可以帮助创作者高效、低成本创作出引人入胜的有声作品。立即体验,让有声书制作更简单!
    100次使用
  • Red Skill - 小红书推出的 AI Skill 分发平台
    Red Skill
    小红书创作服务平台为小红书创作者和机构提供视频上传、数据分析、粉丝管理、创作指导等多项运营服务,助力用户解锁更多创作者专属功能,体验高效创作!
    101次使用
  • MiMo Code - 小米大模型团队开源的新一代 AI 编程助手
    MiMo Code
    MiMo Code 是小米大模型团队开源的新一代 AI 编程助手,面向开发者提供代码理解、生成与辅助开发能力,适合作为 AI 编程工具收藏和体验。
    203次使用
  • TRAE Work - 字节跳动推出的 AI 原生工作台
    TRAE Work
    TRAE AI IDE | 国内首款 AI 原生集成开发环境,深度集成 Doubao-1.5-pro 与 DeepSeek 模型,支持中文自然语言一键生成完整代码框架,实时预览前端效果并智能修复 BUG。首创 Builder 模式实现需求到代码的自动化开发,兼容 Windows/macOS 系统,官网下载即用。
    234次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码