0

0

如何在Golang中实现JSON API接口

P粉602998670

P粉602998670

发布时间:2025-10-27 23:06:02

|

840人浏览过

|

来源于php中文网

原创

答案是使用net/http和encoding/json包可快速构建JSON API。首先定义带json标签的结构体,如User,并用http.HandleFunc注册路由;在处理器中通过w.Header().Set设置Content-Type为application/json,利用json.NewEncoder.Encode返回数据;对于POST请求,使用json.NewDecoder(r.Body).Decode解析输入,同时校验请求方法与JSON格式;建议封装统一响应结构Response包含success、data和message字段,通过sendJSON和sendError函数标准化输出,确保接口一致性。整个过程无需第三方框架,注意设置Header、检查请求方法及错误处理即可实现高效稳定的API服务。

如何在golang中实现json api接口

在Golang中实现JSON API接口不复杂,关键在于使用标准库中的net/httpencoding/json包。只要理解HTTP处理流程和结构体序列化机制,就能快速搭建轻量、高效的API服务。

定义数据结构与路由

先根据业务需求设计结构体,Go会通过标签(tag)控制JSON字段名。然后用http.HandleFunc注册路由,绑定处理函数。

例如,构建一个用户信息API:

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

接着设置路由:

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

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

编写返回JSON的处理器

处理函数中设置响应头为application/json,再用json.NewEncoderjson.Marshal输出数据。

示例:

func getUserHandler(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)
}

这样访问/user就会返回JSON格式的用户信息。

Android JNI开发入门与提高 中文WORD版
Android JNI开发入门与提高 中文WORD版

本文档主要讲述的是Android JNI开发入门与提高;JNI在Android系统中有着广泛的应用。Android系统底层都是C/C++实现的,上层提供的API都是Java的,Java通过JNI调用底层的实现。比如:Android API多媒体接口MediaPlayer类,其实底层通过JNI调用libmedia库。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看

下载

处理POST请求与解析JSON输入

当需要接收客户端提交的数据时,读取r.Body并用json.NewDecoder反序列化到结构体。

比如接收新用户注册

func createUserHandler(w http.ResponseWriter, r *http.Request) {
    if r.Method != "POST" {
        http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
        return
    }

    var user User
    if err := json.NewDecoder(r.Body).Decode(&user); err != nil {
        http.Error(w, "Invalid JSON", http.StatusBadRequest)
        return
    }

    // 此处可添加保存逻辑

    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(map[string]string{"status": "created"})
}

统一错误处理与响应格式

为了API更规范,建议封装通用响应结构和错误返回方式。

定义:

type Response struct {
    Success bool        `json:"success"`
    Data    interface{} `json:"data,omitempty"`
    Message string      `json:"message,omitempty"`
}

使用:

func sendJSON(w http.ResponseWriter, data interface{}, status int) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(status)
    json.NewEncoder(w).Encode(Response{Success: true, Data: data})
}

func sendError(w http.ResponseWriter, message string, status int) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(status)
    json.NewEncoder(w).Encode(Response{Success: false, Message: message})
}

这样能保持所有接口返回格式一致,便于前端处理。

基本上就这些。Golang标准库足够支撑大多数JSON API场景,无需引入框架也能写出清晰可靠的代码。关键是结构体定义准确、错误处理到位、内容类型设置正确。调试时可用curl或Postman测试接口输出。不复杂但容易忽略细节,比如忘记设Header或没检查请求方法。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

180

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

228

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

209

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

393

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

197

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

191

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

253

2025.06.17

php远程文件教程合集
php远程文件教程合集

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

21

2026.01.22

热门下载

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

精品课程

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

共101课时 | 8.4万人学习

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号