Golang如何实现简单的JSON API_Golang JSON API接口设计示例

答案：使用Golang标准库net/http和encoding/json可实现简易JSON API。定义User结构体并模拟数据存储，通过http.HandleFunc注册路由，分别处理GET /users获取用户列表、GET /users/{id}获取单个用户、POST /users创建用户等请求，设置正确响应头、状态码并进行JSON序列化与反序列化，即可完成基础CRUD功能。

用Golang实现一个简单的JSON API并不复杂，核心是使用标准库中的net/http处理HTTP请求，配合encoding/json进行数据序列化。下面通过一个用户管理的接口示例，展示如何设计和实现一个基础的JSON API。

定义数据结构

假设我们要提供一个用户信息的增删查改（CRUD）接口，先定义一个User结构体：

type User struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
    Age  int    `json:"age"`
}

结构体字段使用json:标签，确保在JSON输出时使用小写字段名。

初始化数据和路由

使用切片模拟存储，注册几个路由处理函数：

var users = []User{
    {ID: 1, Name: "Alice", Age: 25},
    {ID: 2, Name: "Bob", Age: 30},
}

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

实现获取用户列表接口

getUsers 处理 GET /users 请求，返回所有用户的JSON数组：

func getUsers(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(users)
}

设置响应头为JSON类型，然后直接编码输出。

实现获取单个用户接口

getUser 处理 GET /users/1 这类请求，提取ID并查找用户：

func getUser(w http.ResponseWriter, r *http.Request) {
    idStr := strings.TrimPrefix(r.URL.Path, "/users/")
    id, err := strconv.Atoi(idStr)
    if err != nil || id <= 0 {
        http.Error(w, "Invalid user ID", http.StatusBadRequest)
        return
    }

    for _, u := range users {
        if u.ID == id {
            w.Header().Set("Content-Type", "application/json")
            json.NewEncoder(w).Encode(u)
            return
        }
    }

    http.Error(w, "User not found", http.StatusNotFound)
}

通过strings.TrimPrefix提取路径中的ID，转换为整数后遍历查找。找到则返回JSON，否则返回404错误。

添加新用户（POST示例）

支持创建用户，处理POST请求：

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

    // 简单生成ID
    if len(users) > 0 {
        newUser.ID = users[len(users)-1].ID + 1
    } else {
        newUser.ID = 1
    }

    users = append(users, newUser)
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(newUser)
}

读取请求体中的JSON数据，反序列化到结构体，分配ID后加入列表，并返回201状态码。

基本上就这些。通过组合http.HandleFunc、结构体和json包，就能快速搭建出可用的JSON API。虽然没有用到第三方框架（如Gin），但标准库已足够应对简单场景。注意处理错误、设置正确的内容类型和状态码，API会更健壮。

# js # json # go # golang # 编码 # app # ai # 路由 # 状态码 # json数组 # 标准库 # gin # 结构体 # 数据结构 # 接口 # 切片 # http # 序列化 # 用户列表 # 几个 # 就能 # 遍历 # 这类 # 提供一个 # 转换为 # 到第

返回目录在线咨询

上一篇：SQLServer性能优化--间接实现函数索引或者Hash索引
下一篇：在人才招聘网建站系统中，如何配置支付功能实现在线缴费？

您的项目需求

*请认真填写需求信息，我们会在24小时内与您取得联系。